chore(release): v3.0.0-beta.131 [skip ci]

Protects the `/api/access` endpoint behind authentication and sanitizes
the result, making it more secure and significantly smaller. To do this:

1. The `permission` keyword is completely omitted from the result
2. Only _truthy_ access results are returned
3. All nested permissions are consolidated when possible

---------

Co-authored-by: Dan Ribbens <dan.ribbens@gmail.com>
Co-authored-by: Jacob Fletcher <jacobsfletch@gmail.com>
Co-authored-by: James <james@trbl.design>

.git-blame-ignore-revs

@@ -28,3 +28,6 @@ fb7d1be2f3325d076b7c967b1730afcef37922c2
 
 # Prettier and lint remaining db packages
 7fd736ea5b2e9fc4ef936e9dc9e5e3d722f6d8bf
+
+# Bump all eslint deps, lint and format
+03291472d6e427ff94e61fca0616cca7796a3a95

.github/ISSUE_TEMPLATE/1.bug_report_v3.yml

@@ -0,0 +1,77 @@
+name: Functionality Bug
+description: '[REPRODUCTION REQUIRED] - Create a bug report'
+labels: ['status: needs-triage', 'v3', 'validate-reproduction']
+body:
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+    validations:
+      required: true
+
+  - type: input
+    id: reproduction-link
+    attributes:
+      label: Link to the code that reproduces this issue
+      description: >-
+        _REQUIRED_: Please provide a link to your reproduction. Note, if the URL is invalid (404 or a private repository), we may close the issue.
+        Either use `npx create-payload-app@beta -t blank` then push to a repo or follow the [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md) for more information.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Which area(s) are affected? (Select all that apply)
+      multiple: true
+      options:
+        - 'Not sure'
+        - 'area: core'
+        - 'area: docs'
+        - 'area: templates'
+        - 'area: ui'
+        - 'db-mongodb'
+        - 'db-postgres'
+        - 'db-sqlite'
+        - 'db-vercel-postgres'
+        - 'email-nodemailer'
+        - 'plugin: cloud'
+        - 'plugin: cloud-storage'
+        - 'plugin: form-builder'
+        - 'plugin: nested-docs'
+        - 'plugin: richtext-lexical'
+        - 'plugin: richtext-slate'
+        - 'plugin: search'
+        - 'plugin: sentry'
+        - 'plugin: seo'
+        - 'plugin: stripe'
+        - 'plugin: other'
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Environment Info
+      description: Paste output from `pnpm payload info` (>= beta.92) _or_ Payload, Node.js, and Next.js versions.
+      render: text
+      placeholder: |
+        Payload:
+        Node.js:
+        Next.js:
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: Before submitting the issue, go through the steps you've written down to make sure the steps provided are detailed and clear.
+  - type: markdown
+    attributes:
+      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
+  - type: markdown
+    attributes:
+      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!

.github/ISSUE_TEMPLATE/2.design_issue.yml

@@ -0,0 +1,40 @@
+name: Design Issue
+description: '[SCREENSHOT REQUIRED] - Create a design issue report'
+labels: ['status: needs-triage', 'v3', 'area: ui']
+body:
+  - type: textarea
+    attributes:
+      label: Describe the Bug.
+      description: >-
+        _REQUIRED:_ Please a screenshot/video of the issue along with a detailed description of the problem.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Environment Info
+      description: Paste output from `pnpm payload info` (>= beta.92) _or_ Payload, Node.js, and Next.js versions.
+      render: text
+      placeholder: |
+        Payload:
+        Node.js:
+        Next.js:
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: Before submitting the issue, go through the steps you've written down to make sure the steps provided are detailed and clear.
+  - type: markdown
+    attributes:
+      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
+  - type: markdown
+    attributes:
+      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!

.github/ISSUE_TEMPLATE/3.bug_report_v2.yml

@@ -1,11 +1,11 @@
-name: Bug Report
-description: Create a bug report for Payload
-labels: ['[possible-bug]']
+name: v2 Bug Report
+description: Report a bug for Payload v2. ONLY CRITICAL bugs will be fixed in v2.
+labels: ['status: needs-triage', 'v2']
 body:
   - type: markdown
     attributes:
       value: |
-        *Note:* Feature requests should be opened as [discussions](https://github.com/payloadcms/payload/discussions/new?category=feature-requests-ideas).
+        ONLY CRITICAL bugs will be fixed in v2.
   - type: input
     id: reproduction-link
     attributes:

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,23 +1,23 @@
-## Description
+<!--
 
-<!-- Please include a summary of the pull request and any related issues it fixes. Please also include relevant motivation and context. -->
+Thank you for the PR! Please go through the checklist below and make sure you've completed all the steps.
 
-- [ ] I have read and understand the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository.
+Please review the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository if you haven't already.
 
-## Type of change
+The following items will ensure that your PR is handled as smoothly as possible:
 
-<!-- Please delete options that are not relevant. -->
+- PR Title must follow conventional commits format. For example, `feat: my new feature`, `fix(plugin-seo): my fix`.
+- Minimal description explained as if explained to someone not immediately familiar with the code.
+- Provide before/after screenshots or code diffs if applicable.
+- Link any related issues/discussions from GitHub or Discord.
+- Add review comments if necessary to explain to the reviewer the logic behind a change
 
-- [ ] Chore (non-breaking change which does not add functionality)
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] Change to the [templates](https://github.com/payloadcms/payload/tree/main/templates) directory (does not affect core functionality)
-- [ ] Change to the [examples](https://github.com/payloadcms/payload/tree/main/examples) directory (does not affect core functionality)
-- [ ] This change requires a documentation update
+### What?
 
-## Checklist:
+### Why?
 
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] Existing test suite passes locally with my changes
-- [ ] I have made corresponding changes to the documentation
+### How?
+
+Fixes #
+
+-->

.github/actions/triage/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Payload <info@payloadcms.com>. All modification and additions are copyright of Payload.
+
+---
+
+Original license:
+ISC License
+
+Copyright (c) 2023, Balázs Orbán
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

.github/actions/triage/README.md

@@ -0,0 +1,21 @@
+# Triage
+
+Modified version of https://github.com/balazsorban44/nissuer
+
+## Modifications
+
+- Port to TypeScript
+- Remove issue locking
+- Remove reproduction blocklist
+- Uses `@vercel/ncc` for packaging
+
+## Development
+
+> [!IMPORTANT]
+> Whenever a modification is made to the action, the action built to `dist` must be committed to the repository.
+
+This is done by running:
+
+```sh
+pnpm build
+```

.github/actions/triage/action.yml

@@ -0,0 +1,40 @@
+name: Triage
+description: Initial triage for issues
+
+inputs:
+  reproduction-comment:
+    description: 'Either a string or a path to a .md file inside the repository. Example: ".github/invalid-reproduction.md"'
+    default: '.github/invalid-reproduction.md'
+  reproduction-hosts:
+    description: 'Comma-separated list of hostnames that are allowed for reproductions. Example: "github.com,codesandbox.io"'
+    default: github.com
+  reproduction-invalid-label:
+    description: 'Label to apply to issues without a valid reproduction. Example: "invalid-reproduction"'
+    default: 'invalid-reproduction'
+  reproduction-issue-labels:
+    description: 'Comma-separated list of issue labels. If configured, only verify reproduction URLs of issues with one of these labels present. Adding a comma at the end will handle non-labeled issues as invalid. Example: "bug,", will consider issues with the label "bug" or no label.'
+    default: ''
+  reproduction-link-section:
+    description: 'A regular expression string with "(.*)" matching a valid URL in the issue body. The result is trimmed. Example: "### Link to reproduction(.*)### To reproduce"'
+    default: '### Link to reproduction(.*)### To reproduce'
+  actions-to-perform:
+    description: 'Comma-separated list of actions to perform on the issue. Example: "tag,comment,close"'
+    default: 'tag,comment,close'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout code
+      if: ${{ github.event_name != 'pull_request' }}
+      uses: actions/checkout@v4
+    - name: Run action
+      run: node ${{ github.action_path }}/dist/index.js
+      shell: sh
+      # https://github.com/actions/runner/issues/665#issuecomment-676581170
+      env:
+        'INPUT_REPRODUCTION_COMMENT': ${{inputs.reproduction-comment}}
+        'INPUT_REPRODUCTION_HOSTS': ${{inputs.reproduction-hosts}}
+        'INPUT_REPRODUCTION_INVALID_LABEL': ${{inputs.reproduction-invalid-label}}
+        'INPUT_REPRODUCTION_ISSUE_LABELS': ${{inputs.reproduction-issue-labels}}
+        'INPUT_REPRODUCTION_LINK_SECTION': ${{inputs.reproduction-link-section}}
+        'INPUT_ACTIONS_TO_PERFORM': ${{inputs.actions-to-perform}}

.github/actions/triage/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['/node_modules/', '<rootDir>/dist/'],
+  transform: {
+    '^.+\\.(t|j)sx?$': ['@swc/jest'],
+  },
+}

.github/actions/triage/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "triage",
+  "version": "0.0.0",
+  "private": true,
+  "description": "GitHub Action to triage new issues",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "pnpm build:typecheck && pnpm build:ncc",
+    "build:ncc": "ncc build src/index.ts -t -o dist",
+    "build:typecheck": "tsc",
+    "clean": "rimraf dist",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@actions/core": "^1.3.0",
+    "@actions/github": "^5.0.0"
+  },
+  "devDependencies": {
+    "@octokit/webhooks-types": "^7.5.1",
+    "@swc/jest": "^0.2.36",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^20.16.5",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
+    "@vercel/ncc": "0.38.1",
+    "concurrently": "^8.2.2",
+    "eslint": "^7.32.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.3",
+    "ts-jest": "^26.5.6",
+    "typescript": "^4.9.5"
+  }
+}

.github/actions/triage/src/index.ts

@@ -0,0 +1,215 @@
+import { debug, error, getBooleanInput, getInput, info, setFailed } from '@actions/core'
+
+import { context, getOctokit } from '@actions/github'
+import { readFile, access } from 'node:fs/promises'
+import { join } from 'node:path'
+
+// Ensure GITHUB_TOKEN and GITHUB_WORKSPACE are present
+if (!process.env.GITHUB_TOKEN) throw new TypeError('No GITHUB_TOKEN provided')
+if (!process.env.GITHUB_WORKSPACE) throw new TypeError('Not a GitHub workspace')
+
+const validActionsToPerform = ['tag', 'comment', 'close'] as const
+type ActionsToPerform = (typeof validActionsToPerform)[number]
+
+// Define the configuration object
+interface Config {
+  invalidLink: {
+    comment: string
+    bugLabels: string[]
+    hosts: string[]
+    label: string
+    linkSection: string
+  }
+  actionsToPerform: ActionsToPerform[]
+  token: string
+  workspace: string
+}
+
+const config: Config = {
+  invalidLink: {
+    comment: getInput('reproduction_comment') || '.github/invalid-reproduction.md',
+    bugLabels: getInput('reproduction_issue_labels')
+      .split(',')
+      .map((l) => l.trim()),
+    hosts: (getInput('reproduction_hosts') || 'github.com').split(',').map((h) => h.trim()),
+    label: getInput('reproduction_invalid_label') || 'invalid-reproduction',
+    linkSection:
+      getInput('reproduction_link_section') || '### Link to reproduction(.*)### To reproduce',
+  },
+  actionsToPerform: (getInput('actions_to_perform') || validActionsToPerform.join(','))
+    .split(',')
+    .map((a) => {
+      const action = a.trim().toLowerCase() as ActionsToPerform
+      if (validActionsToPerform.includes(action)) {
+        return action
+      }
+
+      throw new TypeError(`Invalid action: ${action}`)
+    }),
+  token: process.env.GITHUB_TOKEN,
+  workspace: process.env.GITHUB_WORKSPACE,
+}
+
+// Attempt to parse JSON, return parsed object or error
+function tryParse(json: string): Record<string, unknown> {
+  try {
+    return JSON.parse(json)
+  } catch (e) {
+    setFailed(`Could not parse JSON: ${e instanceof Error ? e.message : e}`)
+    return {}
+  }
+}
+
+// Retrieves a boolean input or undefined based on environment variables
+function getBooleanOrUndefined(value: string): boolean | undefined {
+  const variable = process.env[`INPUT_${value.toUpperCase()}`]
+  return variable === undefined || variable === '' ? undefined : getBooleanInput(value)
+}
+
+// Returns the appropriate label match type
+function getLabelMatch(value: string | undefined): 'name' | 'description' {
+  return value === 'name' ? 'name' : 'description'
+}
+
+// Function to check if an issue contains a valid reproduction link
+async function checkValidReproduction(): Promise<void> {
+  const { issue, action } = context.payload as {
+    issue: { number: number; body: string; labels: { name: string }[] } | undefined
+    action: string
+  }
+
+  if (action !== 'opened' || !issue?.body) return
+
+  const labels = issue.labels.map((l) => l.name)
+
+  const issueMatchingLabel =
+    labels.length &&
+    config.invalidLink.bugLabels.length &&
+    labels.some((l) => config.invalidLink.bugLabels.includes(l))
+
+  if (!issueMatchingLabel) {
+    info(
+      `Issue #${issue.number} does not match required labels: ${config.invalidLink.bugLabels.join(', ')}`,
+    )
+    info(`Issue labels: ${labels.join(', ')}`)
+    return
+  }
+
+  info(`Issue #${issue.number} labels: ${labels.join(', ')}`)
+
+  const { rest: client } = getOctokit(config.token)
+  const common = { ...context.repo, issue_number: issue.number }
+
+  const labelsToRemove = labels.filter((l) => config.invalidLink.bugLabels.includes(l))
+
+  if (await isValidReproduction(issue.body)) {
+    await Promise.all(
+      labelsToRemove.map((label) => client.issues.removeLabel({ ...common, name: label })),
+    )
+
+    return info(`Issue #${issue.number} contains a valid reproduction 💚`)
+  }
+
+  info(`Invalid reproduction, issue will be closed/labeled/commented...`)
+
+  // Adjust labels
+  await Promise.all(
+    labelsToRemove.map((label) => client.issues.removeLabel({ ...common, name: label })),
+  )
+
+  // Tag
+  if (config.actionsToPerform.includes('tag')) {
+    info(`Added label: ${config.invalidLink.label}`)
+    await client.issues.addLabels({ ...common, labels: [config.invalidLink.label] })
+  } else {
+    info('Tag - skipped, not provided in actions to perform')
+  }
+
+  // Comment
+  if (config.actionsToPerform.includes('comment')) {
+    const comment = join(config.workspace, config.invalidLink.comment)
+    await client.issues.createComment({ ...common, body: await getCommentBody(comment) })
+    info(`Commented with invalid reproduction message`)
+  } else {
+    info('Comment - skipped, not provided in actions to perform')
+  }
+
+  // Close
+  if (config.actionsToPerform.includes('close')) {
+    await client.issues.update({ ...common, state: 'closed' })
+    info(`Closed issue #${issue.number}`)
+  } else {
+    info('Close - skipped, not provided in actions to perform')
+  }
+}
+
+/**
+ * Determine if an issue contains a valid/accessible link to a reproduction.
+ *
+ * Returns `true` if the link is valid.
+ * @param body - The body content of the issue
+ */
+async function isValidReproduction(body: string): Promise<boolean> {
+  const linkSectionRe = new RegExp(config.invalidLink.linkSection, 'is')
+  const link = body.match(linkSectionRe)?.[1]?.trim()
+
+  if (!link) {
+    info('Missing link')
+    info(`Link section regex: ${linkSectionRe}`)
+    info(`Link section: ${body}`)
+    return false
+  }
+
+  info(`Checking validity of link: ${link}`)
+
+  if (!URL.canParse(link)) {
+    info(`Invalid URL: ${link}`)
+    return false
+  }
+
+  const url = new URL(link)
+
+  if (!config.invalidLink.hosts.includes(url.hostname)) {
+    info('Link did not match allowed reproduction hosts')
+    return false
+  }
+
+  try {
+    // Verify that the link can be accessed
+    const response = await fetch(link)
+    const isOk = response.status < 400 || response.status >= 500
+
+    info(`Link status: ${response.status}`)
+    if (!isOk) {
+      info(`Link returned status ${response.status}`)
+    }
+    return isOk
+  } catch (error) {
+    info(`Error fetching link: ${(error as Error).message}`)
+    return false
+  }
+}
+
+/**
+ * Return either a file's content or a string
+ * @param {string} pathOrComment
+ */
+async function getCommentBody(pathOrComment: string) {
+  try {
+    await access(pathOrComment)
+    return await readFile(pathOrComment, 'utf8')
+  } catch (error: any) {
+    if (error.code === 'ENOENT') return pathOrComment
+    throw error
+  }
+}
+
+async function run() {
+  const { token, workspace, ...safeConfig } = config
+  info('Configuration:')
+  info(JSON.stringify(safeConfig, null, 2))
+
+  await checkValidReproduction()
+}
+
+run().catch(setFailed)

.github/actions/triage/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es2020.string"],
+    "noEmit": true,
+    "strict": true,
+    "noUnusedLocals": false, // Undo this
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "forceConsistentCasingInFileNames": true,
+    "downlevelIteration": true,
+    "skipLibCheck": true,
+  },
+  "exclude": ["src/**/*.test.ts"]
+}

.github/comments/invalid-reproduction.md

@@ -0,0 +1,20 @@
+**Please add a reproduction in order for us to be able to investigate.**
+
+Depending on the quality of reproduction steps, this issue may be closed if no reproduction is provided.
+
+### Why was this issue marked with the `invalid-reproduction` label?
+
+To be able to investigate, we need access to a reproduction to identify what triggered the issue. We prefer a link to a public GitHub repository created with `create-payload-app@beta -t blank` or a forked/branched version of this repository with tests added (more info in the [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md)).
+
+To make sure the issue is resolved as quickly as possible, please make sure that the reproduction is as **minimal** as possible. This means that you should **remove unnecessary code, files, and dependencies** that do not contribute to the issue. Ensure your reproduction does not depend on secrets, 3rd party registries, private dependencies, or any other data that cannot be made public. Avoid a reproduction including a whole monorepo (unless relevant to the issue). The easier it is to reproduce the issue, the quicker we can help.
+
+Please test your reproduction against the latest version of Payload to make sure your issue has not already been fixed.
+
+### I added a link, why was it still marked?
+
+Ensure the link is pointing to a codebase that is accessible (e.g. not a private repository). "[example.com](http://example.com/)", "n/a", "will add later", etc. are not acceptable links -- we need to see a public codebase. See the above section for accepted links.
+
+### Useful Resources
+
+- [Reproduction Guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md)
+- [Contributing to Payload](https://www.youtube.com/watch?v=08Qa3ggR9rw)

.github/dependabot.yml

@@ -0,0 +1,74 @@
+# docs: https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directories:
+      - /
+      - /.github/workflows
+      - /.github/actions/* # Not working until resolved: https://github.com/dependabot/dependabot-core/issues/6345
+      - /.github/actions/setup
+    target-branch: beta
+    schedule:
+      interval: monthly
+      timezone: America/Detroit
+      time: '06:00'
+    groups:
+      github_actions:
+        patterns:
+          - '*'
+
+  - package-ecosystem: npm
+    directory: /
+    target-branch: beta
+    schedule:
+      interval: weekly
+      day: sunday
+      timezone: America/Detroit
+      time: '06:00'
+    commit-message:
+      prefix: 'chore(deps)'
+    labels:
+      - dependencies
+    groups:
+      production-deps:
+        dependency-type: production
+        update-types:
+          - minor
+          - patch
+        patterns:
+          - '*'
+        exclude-patterns:
+          - 'drizzle*'
+      dev-deps:
+        dependency-type: development
+        update-types:
+          - minor
+          - patch
+        patterns:
+          - '*'
+        exclude-patterns:
+          - 'drizzle*'
+
+  # Only bump patch versions for 2.x
+  - package-ecosystem: npm
+    directory: /
+    target-branch: main
+    schedule:
+      interval: weekly
+      day: sunday
+      timezone: America/Detroit
+      time: '06:00'
+    commit-message:
+      prefix: 'chore(deps)'
+    labels:
+      - dependencies
+    groups:
+      production-deps:
+        dependency-type: production
+        update-types:
+          - patch
+        patterns:
+          - '*'
+        exclude-patterns:
+          - 'drizzle*'

.github/pnpm-lock.yaml

@@ -55,6 +55,55 @@ importers:
         specifier: ^4.9.5
         version: 4.9.5
 
+  actions/triage:
+    dependencies:
+      '@actions/core':
+        specifier: ^1.3.0
+        version: 1.10.1
+      '@actions/github':
+        specifier: ^5.0.0
+        version: 5.1.1
+    devDependencies:
+      '@octokit/webhooks-types':
+        specifier: ^7.5.1
+        version: 7.5.1
+      '@swc/jest':
+        specifier: ^0.2.36
+        version: 0.2.36(@swc/core@1.7.26)
+      '@types/jest':
+        specifier: ^27.5.2
+        version: 27.5.2
+      '@types/node':
+        specifier: ^20.16.5
+        version: 20.16.5
+      '@typescript-eslint/eslint-plugin':
+        specifier: ^4.33.0
+        version: 4.33.0(@typescript-eslint/parser@4.33.0(eslint@7.32.0)(typescript@4.9.5))(eslint@7.32.0)(typescript@4.9.5)
+      '@typescript-eslint/parser':
+        specifier: ^4.33.0
+        version: 4.33.0(eslint@7.32.0)(typescript@4.9.5)
+      '@vercel/ncc':
+        specifier: 0.38.1
+        version: 0.38.1
+      concurrently:
+        specifier: ^8.2.2
+        version: 8.2.2
+      eslint:
+        specifier: ^7.32.0
+        version: 7.32.0
+      jest:
+        specifier: ^29.7.0
+        version: 29.7.0(@types/node@20.16.5)
+      prettier:
+        specifier: ^3.3.3
+        version: 3.3.3
+      ts-jest:
+        specifier: ^26.5.6
+        version: 26.5.6(jest@29.7.0(@types/node@20.16.5))(typescript@4.9.5)
+      typescript:
+        specifier: ^4.9.5
+        version: 4.9.5
+
 packages:
 
   '@actions/core@1.10.1':

.github/workflows/label-author.yml

@@ -1,68 +0,0 @@
-name: label-author
-
-on:
-  pull_request:
-    types: [opened]
-  issues:
-    types: [opened]
-
-permissions:
-  contents: read
-  pull-requests: write
-  issues: write
-
-jobs:
-  debug-context:
-    runs-on: ubuntu-latest
-    steps:
-      - name: View context attributes
-        uses: actions/github-script@v7
-        with:
-          script: console.log(context)
-
-  label-created-by:
-    name: Label pr/issue on opening
-    runs-on: ubuntu-latest
-    steps:
-      - name: Tag with 'created-by'
-        uses: actions/github-script@v7
-        if: github.event.action == 'opened'
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const type = context.payload.pull_request ? 'pull_request' : 'issue';
-            const association = context.payload[type].author_association;
-            let label = '';
-            if (
-              association === 'MEMBER' ||
-              association === 'OWNER' ||
-              [
-                'denolfe',
-                'jmikrut',
-                'danribbens',
-
-                'alessiogr',
-                'jacobsfletch',
-                'jarrodmflesch',
-                'jesschowdhury',
-                'kendelljoseph',
-                'patrikkozak',
-                'paulpopus',
-                'r1tsuu',
-                'tylandavis',
-              ].includes(context.actor.toLowerCase())
-            ) {
-              label = 'created-by: Payload team';
-            } else if (association === 'CONTRIBUTOR') {
-              label = 'created-by: Contributor';
-            }
-
-            if (!label) return;
-
-            github.rest.issues.addLabels({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              labels: [label],
-            });
-            console.log(`Added '${label}' label`);

.github/workflows/label-on-change.yml

@@ -0,0 +1,116 @@
+name: label-on-change
+
+on:
+  # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
+  issues:
+    types:
+      - assigned
+      - closed
+      - labeled
+      - reopened
+
+  # TODO: Handle labeling on comment
+
+jobs:
+  on-labeled-ensure-one-status:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    # Only run on issue labeled and if label starts with 'status:'
+    if: github.event.action == 'labeled' && startsWith(github.event.label.name, 'status:')
+    steps:
+      - name: Ensure only one status label
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            // Get all labels that start with 'status:' and are not the incoming label
+            const incomingLabelName = context.payload.label.name;
+            const labelNamesToRemove = context.payload.issue.labels
+              .filter(label => label.name.startsWith('status:') && label.name !== incomingLabelName)
+              .map(label => label.name);
+
+            if (!labelNamesToRemove.length) {
+              console.log('No labels to remove');
+              return;
+            }
+
+            console.log(`Labels to remove: '${labelNamesToRemove}'`);
+
+            // If there is more than one status label, remove all but the incoming label
+            for (const labelName of labelNamesToRemove) {
+              await github.rest.issues.removeLabel({
+                issue_number: context.issue.number,
+                name: labelName,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+              });
+              console.log(`Removed '${labelName}' label`);
+            }
+
+  on-issue-close:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    if: github.event.action == 'closed'
+    steps:
+      - name: Remove all labels on issue close
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            // Get all labels that start with 'status:' and 'stale'
+            const labelNamesToRemove = context.payload.issue.labels
+              .filter(label => label.name.startsWith('status:') || label.name === 'stale')
+              .map(label => label.name);
+
+            if (!labelNamesToRemove.length) {
+              console.log('No labels to remove');
+              return;
+            }
+
+            console.log(`Labels to remove: '${labelNamesToRemove}'`);
+
+            for (const labelName of labelNamesToRemove) {
+              await github.rest.issues.removeLabel({
+                issue_number: context.issue.number,
+                name: labelName,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+              });
+              console.log(`Removed '${labelName}' label`);
+            }
+
+  on-issue-reopen:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    if: github.event.action == 'reopened'
+    steps:
+      - name: Add needs-triage label on issue reopen
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          labels: 'status: needs-triage'
+
+  on-issue-assigned:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    if: >
+      github.event.action == 'assigned' &&
+      contains(github.event.issue.labels.*.name, 'status: needs-triage')
+    steps:
+      - name: Remove needs-triage label on issue assign
+        uses: actions-ecosystem/action-remove-labels@v1
+        with:
+          labels: 'status: needs-triage'
+
+  # on-pr-merge:
+  #   runs-on: ubuntu-latest
+  #   if: github.event.pull_request.merged == true
+  #   steps:
+
+  # on-pr-close:
+  #   runs-on: ubuntu-latest
+  #   if: github.event_name == 'pull_request_target' && github.event.pull_request.merged == false
+  #   steps:

.github/workflows/lock-issues.yml

@@ -0,0 +1,26 @@
+name: lock-issues
+
+on:
+  schedule:
+    # Run nightly at 12am EST
+    - cron: '0 4 * * *'
+  workflow_dispatch:
+
+permissions:
+  issues: write
+
+jobs:
+  lock_issues:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Lock issues
+        uses: dessant/lock-threads@v5
+        with:
+          process-only: 'issues'
+          issue-inactive-days: '1'
+          exclude-any-issue-labels: 'status: awaiting-reply'
+          log-output: true
+          issue-comment: >
+            This issue has been automatically locked.
+
+            Please open a new issue if this issue persists with any additional detail.

.github/workflows/main.yml

@@ -48,6 +48,7 @@ jobs:
               - 'test/**'
               - 'pnpm-lock.yaml'
               - 'package.json'
+              - 'templates/**'
             templates:
               - 'templates/**'
       - name: Log all filter results
@@ -187,6 +188,7 @@ jobs:
   tests-int:
     runs-on: ubuntu-latest
     needs: build
+    name: int-${{ matrix.database }}
     strategy:
       fail-fast: false
       matrix:
@@ -206,6 +208,19 @@ jobs:
       AWS_SECRET_ACCESS_KEY: localstack
       AWS_REGION: us-east-1
 
+    services:
+      postgres:
+        image: ${{ (startsWith(matrix.database, 'postgres') ) && 'postgis/postgis:16-3.4' || '' }}
+        env:
+          # must specify password for PG Docker container image, see: https://registry.hub.docker.com/_/postgres?tab=description&page=1&name=10
+          POSTGRES_USER: ${{ env.POSTGRES_USER }}
+          POSTGRES_PASSWORD: ${{ env.POSTGRES_PASSWORD }}
+          POSTGRES_DB: ${{ env.POSTGRES_DB }}
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
     steps:
       - uses: actions/checkout@v4
         with:
@@ -230,15 +245,6 @@ jobs:
       - name: Start LocalStack
         run: pnpm docker:start
 
-      - name: Start PostgreSQL
-        uses: CasperWA/postgresql-action@v1.2
-        with:
-          postgresql version: '14' # See https://hub.docker.com/_/postgres for available versions
-          postgresql db: ${{ env.POSTGRES_DB }}
-          postgresql user: ${{ env.POSTGRES_USER }}
-          postgresql password: ${{ env.POSTGRES_PASSWORD }}
-        if: startsWith(matrix.database, 'postgres')
-
       - name: Install Supabase CLI
         uses: supabase/setup-cli@v1
         with:
@@ -251,10 +257,6 @@ jobs:
           supabase start
         if: matrix.database == 'supabase'
 
-      - name: Wait for PostgreSQL
-        run: sleep 30
-        if: startsWith(matrix.database, 'postgres')
-
       - name: Configure PostgreSQL
         run: |
           psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "CREATE ROLE runner SUPERUSER LOGIN;"
@@ -282,6 +284,7 @@ jobs:
   tests-e2e:
     runs-on: ubuntu-latest
     needs: build
+    name: ${{ matrix.suite }}
     strategy:
       fail-fast: false
       matrix:
@@ -390,10 +393,33 @@ jobs:
       #     report-tag: ${{ matrix.suite }}
       #     job-summary: true
 
-  app-build-with-packed:
-    if: false # Disable until package resolution in tgzs can be figured out
+  # Build listed templates with packed local packages
+  build-templates:
     runs-on: ubuntu-latest
     needs: build
+    strategy:
+      matrix:
+        include:
+          - template: blank
+            database: mongodb
+          - template: website
+            database: mongodb
+          - template: with-payload-cloud
+            database: mongodb
+          - template: with-vercel-mongodb
+            database: mongodb
+          # Postgres
+          - template: with-postgres
+            database: postgres
+          - template: with-vercel-postgres
+            database: postgres
+
+    name: ${{ matrix.template }}-${{ matrix.database }}
+
+    env:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: payloadtests
 
     steps:
       # https://github.com/actions/virtual-environments/issues/1187
@@ -418,22 +444,35 @@ jobs:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
 
+      - name: Start PostgreSQL
+        uses: CasperWA/postgresql-action@v1.2
+        with:
+          postgresql version: '14' # See https://hub.docker.com/_/postgres for available versions
+          postgresql db: ${{ env.POSTGRES_DB }}
+          postgresql user: ${{ env.POSTGRES_USER }}
+          postgresql password: ${{ env.POSTGRES_PASSWORD }}
+        if: matrix.database == 'postgres'
+
+      - name: Wait for PostgreSQL
+        run: sleep 30
+        if: matrix.database == 'postgres'
+
+      - name: Configure PostgreSQL
+        run: |
+          psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "CREATE ROLE runner SUPERUSER LOGIN;"
+          psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "SELECT version();"
+          echo "POSTGRES_URL=postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" >> $GITHUB_ENV
+        if: matrix.database == 'postgres'
+
       - name: Start MongoDB
         uses: supercharge/mongodb-github-action@1.11.0
         with:
           mongodb-version: 6.0
 
-      - name: Pack and build app
+      - name: Build Template
         run: |
-          set -ex
-          pnpm run script:pack --dest templates/blank
-          cd templates/blank
-          cp .env.example .env
-          ls -la
-          pnpm add ./*.tgz --ignore-workspace
-          pnpm install --ignore-workspace --no-frozen-lockfile
-          cat package.json
-          pnpm run build
+          pnpm run script:pack --dest templates/${{ matrix.template }}
+          pnpm runts scripts/build-template-with-local-pkgs.ts ${{ matrix.template }} $POSTGRES_URL
 
   tests-type-generation:
     runs-on: ubuntu-latest
@@ -468,72 +507,6 @@ jobs:
       - name: Generate GraphQL schema file
         run: pnpm dev:generate-graphql-schema graphql-schema-gen
 
-  templates:
-    needs: changes
-    if: false # Disable until templates are updated for 3.0
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        template: [blank, website, ecommerce]
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 25
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.11.0
-        with:
-          mongodb-version: 6.0
-
-      - name: Build Template
-        run: |
-          cd templates/${{ matrix.template }}
-          cp .env.example .env
-          yarn install
-          yarn build
-          yarn generate:types
-
-  generated-templates:
-    needs: build
-    if: false # Needs to pull in tgz files from build
-    runs-on: ubuntu-latest
-
-    steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v4
-        timeout-minutes: 10
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build all generated templates
-        run: pnpm tsx ./scripts/build-generated-templates.ts
-
   all-green:
     name: All Green
     if: always()
@@ -552,6 +525,7 @@ jobs:
   publish-canary:
     name: Publish Canary
     runs-on: ubuntu-latest
+    if: ${{ needs.all-green.result == 'success' && github.ref_name == 'beta' }}
     needs:
       - all-green
 
@@ -560,4 +534,3 @@ jobs:
       - run: |
           echo github.ref: ${{ github.ref }}
           echo isBeta: ${{ github.ref == 'refs/heads/beta' }}
-          echo isMain: ${{ github.ref == 'refs/heads/main' }}

.github/workflows/pr-title.yml

@@ -46,6 +46,7 @@ jobs:
             live-preview
             live-preview-react
             next
+            payload-cloud
             plugin-cloud
             plugin-cloud-storage
             plugin-form-builder

.github/workflows/stale.yml

@@ -0,0 +1,42 @@
+name: stale
+
+on:
+  workflow_dispatch:
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v9
+        id: stale
+        with:
+          debug-only: true
+          days-before-stale: 90
+          days-before-close: 7
+          ascending: true
+          operations-per-run: 300
+
+          # Ignore all assigned
+          exempt-all-assignees: false
+
+          # Issues
+          stale-issue-label: 'stale'
+          exempt-issue-labels: 'blocked,must,should,keep,created-by: Payload team,created-by: Contributor'
+          stale-issue-message: >
+            This issue has been marked as stale due to lack of activity. To keep the ticket open, please indicate that it is still relevant in a comment below.
+          close-issue-message: >
+            This issue was automatically closed due to lack of activity.
+
+          # Pull Requests
+          stale-pr-label: 'stale'
+          exempt-pr-labels: 'blocked,must,should,keep,created-by: Payload team,created-by: Contributor'
+          stale-pr-message: >
+            This PR is stale due to lack of activity. To keep the PR open, please indicate that it is still relevant in a comment below.
+          close-pr-message: >
+            This pull request was automatically closed due to lack of activity.
+
+      - name: Print outputs
+        run: echo ${{ format('{0},{1}', toJSON(steps.stale.outputs.staled-issues-prs), toJSON(steps.stale.outputs.closed-issues-prs)) }}

.github/workflows/triage.yml

@@ -0,0 +1,102 @@
+name: triage
+
+on:
+  pull_request:
+    types:
+      - opened
+  issues:
+    types:
+      - opened
+
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
+jobs:
+  debug-context:
+    runs-on: ubuntu-latest
+    steps:
+      - name: View context attributes
+        uses: actions/github-script@v7
+        with:
+          script: console.log({ context })
+
+  label-created-by:
+    name: label-on-open
+    runs-on: ubuntu-latest
+    steps:
+      - name: Tag with 'created-by'
+        uses: actions/github-script@v7
+        if: github.event.action == 'opened'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const payloadTeamUsernames = [
+              'denolfe',
+              'jmikrut',
+              'DanRibbens',
+              'jacobsfletch',
+              'JarrodMFlesch',
+              'AlessioGr',
+              'JessChowdhury',
+              'kendelljoseph',
+              'PatrikKozak',
+              'tylandavis',
+              'paulpopus',
+              'r1tsuu',
+              'GermanJablo',
+            ];
+
+            const type = context.payload.pull_request ? 'pull_request' : 'issue';
+
+            const isTeamMember = payloadTeamUsernames
+              .map(n => n.toLowerCase())
+              .includes(context.payload[type].user.login.toLowerCase());
+
+            if (isTeamMember) {
+              github.rest.issues.addLabels({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                labels: ['created-by: Payload team'],
+              });
+              console.log(`Added 'created-by: Payload team' label`);
+              return;
+            }
+
+            const association = context.payload[type].author_association;
+            let label = ''
+            if (association === 'MEMBER' || association === 'OWNER') {
+              label = 'created-by: Payload team';
+            } else if (association === 'CONTRIBUTOR') {
+              label = 'created-by: Contributor';
+            }
+
+            if (!label) return;
+
+            github.rest.issues.addLabels({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              labels: [label],
+            });
+            console.log(`Added '${label}' label.`);
+
+  triage:
+    name: initial-triage
+    if: github.event_name == 'issues'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: ./.github/actions/triage
+        with:
+          reproduction-comment: '.github/comments/invalid-reproduction.md'
+          reproduction-link-section: '### Link to the code that reproduces this issue(.*)### Reproduction Steps'
+          reproduction-issue-labels: 'validate-reproduction'
+          actions-to-perform: 'tag,comment'

README.md

@@ -1,4 +1,4 @@
-<a href="https://payloadcms.com"><img width="100%" src="https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/assets/images/github-banner-alt.jpg?raw=true" alt="Payload headless CMS Admin panel built with React" /></a>
+<a href="https://payloadcms.com"><img width="100%" src="https://github.com/payloadcms/payload/blob/beta/packages/payload/src/assets/images/github-banner-nextjs-native.jpg" alt="Payload headless CMS Admin panel built with React" /></a>
 <br />
 <br />
 
@@ -7,80 +7,74 @@
   &nbsp;
   <a href="https://discord.gg/payload"><img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da&style=flat-square" /></a>
   &nbsp;
+  <a href="https://www.npmjs.com/package/payload"><img alt="npm" src="https://img.shields.io/npm/dw/payload?style=flat-square" /></a>
+  &nbsp;
   <a href="https://www.npmjs.com/package/payload"><img alt="npm" src="https://img.shields.io/npm/v/payload?style=flat-square" /></a>
   &nbsp;
   <a href="https://twitter.com/payloadcms"><img src="https://img.shields.io/badge/follow-payloadcms-1DA1F2?logo=twitter&style=flat-square" alt="Payload Twitter" /></a>
 </p>
 <hr/>
 <h4>
-<a target="_blank" href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the Docs</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://payloadcms.com/community-help" rel="dofollow"><strong>Community Help</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://demo.payloadcms.com/" rel="dofollow"><strong>Try Live Demo</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://github.com/payloadcms/payload/discussions/1539" rel="dofollow"><strong>Roadmap</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://www.g2.com/products/payload-cms/reviews#reviews" rel="dofollow"><strong>View G2 Reviews</strong></a>
+<a target="_blank" href="https://payloadcms.com/docs/beta/getting-started/what-is-payload" rel="dofollow"><strong>Explore the Docs</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://payloadcms.com/community-help" rel="dofollow"><strong>Community Help</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://github.com/payloadcms/payload/discussions/1539" rel="dofollow"><strong>Roadmap</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://www.g2.com/products/payload-cms/reviews#reviews" rel="dofollow"><strong>View G2 Reviews</strong></a>
 </h4>
 <hr/>
 
 > [!IMPORTANT]
-> 🎉 <strong>Payload 2.0 is now available!</strong> Read more in the <a target="_blank" href="https://payloadcms.com/blog/payload-2-0" rel="dofollow"><strong>announcement post</strong></a>.
+> 🚨 <strong>We're about to release 3.0 stable.</strong> Star this repo or keep an eye on it to follow along.
+
+Payload is the first-ever Next.js native CMS that can install directly in your existing `/app` folder. It's the start of a new era for headless CMS.
 
 <h3>Benefits over a regular CMS</h3>
 <ul>
-  <li>Don’t hit some third-party SaaS API, hit your own API</li>
-  <li>Use your own database and own your data</li>
-  <li>It's just Express - do what you want outside of Payload</li>
-  <li>No need to learn how Payload works - if you know JS, you know Payload</li>
+  <li>Deploy anywhere, including serverless on Vercel for free</li>
+  <li>Combine your front+backend in the same <code>/app</code> folder if you want</li>
+  <li>Don't sign up for yet another SaaS - Payload is open source</li>
+  <li>Query your database in React Server Components</li>
+  <li>Both admin and backend are 100% extensible</li>
   <li>No vendor lock-in</li>
-  <li>Avoid microservices hell - get everything (even auth) in one place</li>
   <li>Never touch ancient WP code again</li>
   <li>Build faster, never hit a roadblock</li>
-  <li>Both admin and backend are 100% extensible</li>
 </ul>
 
-## ☁️ Deploy instantly with Payload Cloud.
+## Quickstart
 
-Create a cloud account, connect your GitHub, and [deploy in minutes](https://payloadcms.com/new).
-
-## 🚀 Get started by self-hosting completely free, forever.
-
-Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation).
+Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/beta/getting-started/installation).
 
 ```text
-npx create-payload-app@latest
+pnpx create-payload-app@beta
 ```
 
-Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
+**If you're new to Payload, you should start with the 3.0 beta website template** (`pnpx create-payload-app@beta -t website`). It shows how to do _everything_ - including custom Rich Text blocks, on-demand revalidation, live preview, and more. It comes with a frontend built with Tailwind all in one `/app` folder.
 
-## 🖱️ One-click templates
+## One-click templates
 
 Jumpstart your next project by starting with a pre-made template. These are production-ready, end-to-end solutions designed to get you to market as fast as possible.
 
-### [🛒 E-Commerce](https://github.com/payloadcms/payload/tree/main/templates/ecommerce)
+### [🌐 Website](https://github.com/payloadcms/payload/tree/beta/templates/website)
 
-Eliminate the need to combine Shopify and a CMS, and instead do it all with Payload + Stripe. Comes with a beautiful, fully functional front-end complete with shopping cart, checkout, orders, and much more.
+Build any kind of website, blog, or portfolio from small to enterprise. Comes with a fully functional front-end built with RSCs and Tailwind.
 
-### [🌐 Website](https://github.com/payloadcms/payload/tree/main/templates/website)
+We're constantly adding more templates to our [Templates Directory](https://github.com/payloadcms/payload/tree/beta/templates). If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find.
 
-Build any kind of website, blog, or portfolio from small to enterprise. Comes with a beautiful, fully functional front-end complete with posts, projects, comments, and much more.
-
-We're constantly adding more templates to our [Templates Directory](https://github.com/payloadcms/payload/tree/main/templates). If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find.
-
-- [Official Templates](https://github.com/payloadcms/payload/tree/main/templates)
+- [Official Templates](https://github.com/payloadcms/payload/tree/beta/templates)
 - [Community Templates](https://github.com/topics/payload-template)
 
 ## ✨ Features
 
 - Completely free and open-source
-- [GraphQL](https://payloadcms.com/docs/graphql/overview), [REST](https://payloadcms.com/docs/rest-api/overview), and [Local](https://payloadcms.com/docs/local-api/overview) APIs
-- [Easily customizable ReactJS Admin](https://payloadcms.com/docs/admin/overview)
-- [Fully self-hosted](https://payloadcms.com/docs/production/deployment)
-- [Extensible Authentication](https://payloadcms.com/docs/authentication/overview)
-- [Local file storage & upload](https://payloadcms.com/docs/upload/overview)
-- [Version History and Drafts](https://payloadcms.com/docs/versions/overview)
-- [Field-based Localization](https://payloadcms.com/docs/configuration/localization)
-- [Block-based Layout Builder](https://payloadcms.com/docs/fields/blocks)
-- [Extensible SlateJS rich text editor](https://payloadcms.com/docs/fields/rich-text)
-- [Array field type](https://payloadcms.com/docs/fields/array)
-- [Field conditional logic](https://payloadcms.com/docs/fields/overview#conditional-logic)
-- Extremely granular [Access Control](https://payloadcms.com/docs/access-control/overview)
-- [Document and field-level hooks](https://payloadcms.com/docs/hooks/overview) for every action Payload provides
-- Built with Typescript & very Typescript-friendly
+- Next.js native, built to run inside _your_ `/app` folder
+- Use server components to extend Payload UI
+- Query your database directly in server components, no need for REST / GraphQL
+- Fully TypeScript with automatic types for your data
+- [Auth out of the box](https://payloadcms.com/docs/beta/authentication/overview)
+- [Versions and drafts](https://payloadcms.com/docs/beta/versions/overview)
+- [Localization](https://payloadcms.com/docs/beta/configuration/localization)
+- [Block-based kayout builder](https://payloadcms.com/docs/beta/fields/blocks)
+- [Customizable React admin](https://payloadcms.com/docs/beta/admin/overview)
+- [Lexical rich text editor](https://payloadcms.com/docs/beta/fields/rich-text)
+- [Conditional field logic](https://payloadcms.com/docs/beta/fields/overview#conditional-logic)
+- Extremely granular [Access Control](https://payloadcms.com/docs/beta/access-control/overview)
+- [Document and field-level hooks](https://payloadcms.com/docs/beta/hooks/overview) for every action Payload provides
 - Intensely fast API
 - Highly secure thanks to HTTP-only cookies, CSRF protection, and more
 
@@ -88,7 +82,7 @@ We're constantly adding more templates to our [Templates Directory](https://gith
 
 ## 🗒️ Documentation
 
-Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
+Check out the [Payload website](https://payloadcms.com/docs/beta/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
 
 Migrating from v1 to v2? Check out the [2.0 Release Notes](https://github.com/payloadcms/payload/releases/tag/v2.0.0) on how to do it.
 

app/(payload)/api/graphql/route.ts

@@ -1,6 +1,8 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
 /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
 import config from '@payload-config'
-import { GRAPHQL_POST } from '@payloadcms/next/routes'
+import { GRAPHQL_POST, REST_OPTIONS } from '@payloadcms/next/routes'
 
 export const POST = GRAPHQL_POST(config)
+
+export const OPTIONS = REST_OPTIONS(config)

app/(payload)/layout.tsx

@@ -1,8 +1,10 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
 /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
-import configPromise from '@payload-config'
-import { RootLayout } from '@payloadcms/next/layouts'
 // import '@payloadcms/ui/styles.css' // Uncomment this line if `@payloadcms/ui` in `tsconfig.json` points to `/ui/dist` instead of `/ui/src`
+import type { ServerFunctionClient } from 'payload'
+
+import config from '@payload-config'
+import { handleServerFunctions, RootLayout } from '@payloadcms/next/layouts'
 import React from 'react'
 
 import { importMap } from './admin/importMap.js'
@@ -12,8 +14,17 @@ type Args = {
   children: React.ReactNode
 }
 
+const serverFunction: ServerFunctionClient = async function (args) {
+  'use server'
+  return handleServerFunctions({
+    ...args,
+    config,
+    importMap,
+  })
+}
+
 const Layout = ({ children }: Args) => (
-  <RootLayout config={configPromise} importMap={importMap}>
+  <RootLayout config={config} importMap={importMap} serverFunction={serverFunction}>
     {children}
   </RootLayout>
 )

docs/access-control/overview.mdx

@@ -18,7 +18,7 @@ There are many use cases for Access Control, including:
 - Only allowing public access to posts where a `status` field is equal to `published`
 - Giving only users with a `role` field equal to `admin` the ability to delete posts
 - Allowing anyone to submit contact forms, but only logged in users to `read`, `update` or `delete` them
-- Restricting a user to only be able to see their own orders, but noone else's
+- Restricting a user to only be able to see their own orders, but no-one else's
 - Allowing users that belong to a certain organization to access only that organization's resources
 
 There are three main types of Access Control in Payload:

docs/admin/collections.mdx

@@ -31,7 +31,7 @@ The following options are available:
 | **`hidden`**                     | Set to true or a function, called with the current user, returning true to exclude this Collection from navigation and admin routing.                                                                                 |
 | **`hooks`**                      | Admin-specific hooks for this Collection. [More details](../hooks/collections).                                                                                                                                       |
 | **`useAsTitle`**                 | Specify a top-level field to use for a document title throughout the Admin Panel. If no field is defined, the ID of the document is used as the title. A field with `virtual: true` cannot be used as the title.      |
-| **`description`**                | Text to display below the Collection label in the List View to give editors more information. Alternatively, you can use the `admin.components.Description` to render a React component. [More details](#components). |
+| **`description`**                | Text to display below the Collection label in the List View to give editors more information. Alternatively, you can use the `admin.components.Description` to render a React component. [More details](#custom-components). |
 | **`defaultColumns`**             | Array of field names that correspond to which columns to show by default in this Collection's List View.                                                                                                              |
 | **`hideAPIURL`**                 | Hides the "API URL" meta field while editing documents within this Collection.                                                                                                                                        |
 | **`enableRichTextLink`**         | The [Rich Text](../fields/rich-text) field features a `Link` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default.                            |
@@ -39,11 +39,12 @@ The following options are available:
 | **`meta`**                       | Page metadata overrides to apply to this Collection within the Admin Panel. [More details](./metadata).                                                                                                               |
 | **`preview`**                    | Function to generate preview URLs within the Admin Panel that can point to your app. [More details](#preview).                                                                                                        |
 | **`livePreview`**                | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                                                                         |
-| **`components`**                 | Swap in your own React components to be used within this Collection. [More details](#components).                                                                                                                     |
+| **`components`**                 | Swap in your own React components to be used within this Collection. [More details](#custom-components).                                                                                                                     |
 | **`listSearchableFields`**       | Specify which fields should be searched in the List search view. [More details](#list-searchable-fields).                                                                                                             |
 | **`pagination`**                 | Set pagination-specific options for this Collection. [More details](#pagination).                                                                                                                                     |
+| **`baseListFilter`**             | You can define a default base filter for this collection's List view, which will be merged into any filters that the user performs.                                                                                   |
 
-### Components
+### Custom Components
 
 Collections can set their own [Custom Components](./components) which only apply to [Collection](../configuration/collections)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
 

docs/admin/components.mdx

@@ -6,9 +6,9 @@ desc: Fully customize your Admin Panel by swapping in your own React components.
 keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-The Payload [Admin Panel](./overview) is designed to be as minimal and straightforward as possible to allow for both easy customization and full control over the UI. In order for Payload to support this level of customization, Payload provides a pattern for you to supply your own React components through your [Payload Config](../configuration/overview).
+The Payload [Admin Panel](./overview) is designed to be as minimal and straightforward as possible to allow for easy customization and full control over the UI. In order for Payload to support this level of customization, Payload provides a pattern for you to supply your own React components through your [Payload Config](../configuration/overview).
 
-All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly on the front-end. Custom Components are available for nearly every part of the Admin Panel for extreme granularity and control.
+All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api/overview) directly on the front-end. Custom Components are available for nearly every part of the Admin Panel for extreme granularity and control.
 
 <Banner type="success">
   <strong>Note:</strong>
@@ -18,51 +18,45 @@ All Custom Components in Payload are [React Server Components](https://react.dev
 There are four main types of Custom Components in Payload:
 
 - [Root Components](#root-components)
-- [Collection Components](./collections#components)
-- [Global Components](./globals#components)
-- [Field Components](./fields)
+- [Collection Components](./collections#custom-components)
+- [Global Components](./globals#custom-components)
+- [Field Components](./fields#custom-components)
 
-To swap in your own Custom Component, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-components) accordingly.
+To swap in your own Custom Component, first consult the list of available components, determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-components) accordingly.
 
+## Defining Custom Components
 
-## Defining Custom Components in the Payload Config
+As Payload compiles the Admin Panel, it checks your config for Custom Components. When detected, Payload either replaces its own default component with yours, or if none exists by default, renders yours outright. While are many places where Custom Components are supported in Payload, each is defined in the same way using [Component Paths](#component-paths).
 
-In the Payload Config, you can define custom React Components to enhance the admin interface. However, these components should not be imported directly into the server-only Payload Config to avoid including client-side code. Instead, you specify the path to the component. Here’s how you can do it:
+To add a Custom Component, point to its file path in your Payload Config:
 
-
-src/components/Logout.tsx
-```tsx
-'use client'
-import React from 'react'
-
-export const MyComponent = () => {
-  return (
-    <button>Click me!</button>
-  )
-}
-```
-
-payload.config.ts:
 ```ts
 import { buildConfig } from 'payload'
 
 const config = buildConfig({
   // ...
-  admin: { // highlight-line
+  admin: {
     components: {
       logout: {
-        Button: '/src/components/Logout#MyComponent'
+        Button: '/src/components/Logout#MyComponent' // highlight-line
       }
     }
   },
 })
 ```
 
-In the path `/src/components/Logout#MyComponent`, `/src/components/Logout` is the file path, and `MyComponent` is the named export. If the component is the default export, the export name can be omitted. Path and export name are separated by a `#`.
+<Banner type="success">
+  <strong>Note:</strong>
+  All Custom Components can be either Server Components or Client Components, depending on the presence of the `use client` directive at the top of the file.
+</Banner>
 
-### Configuring the Base Directory
+### Component Paths
 
-Component paths, by default, are relative to your working directory - this is usually where your Next.js config lies. To simplify component paths, you have the option to configure the *base directory* using the `admin.baseDir.baseDir` property:
+In order to ensure the Payload Config is fully Node.js compatible and as lightweight as possible, components are not directly imported into your config. Instead, they are identified by their file path for the Admin Panel to resolve on its own.
+
+Component Paths, by default, are relative to your project's base directory. This is either your current working directory, or the directory specified in `config.admin.baseDir`. To simplify Component Paths, you can also configure the base directory using the `admin.importMap.baseDir` property.
+
+Components using named exports are identified either by appending `#` followed by the export name, or using the `exportName` property. If the component is the default export, this can be omitted.
 
 ```ts
 import { buildConfig } from 'payload'
@@ -73,137 +67,72 @@ const dirname = path.dirname(filename)
 
 const config = buildConfig({
   // ...
-  admin: { // highlight-line
-     importMap: {
-      baseDir: path.resolve(dirname, 'src'),
+  admin: {
+    importMap: {
+      baseDir: path.resolve(dirname, 'src'), // highlight-line
     },
     components: {
       logout: {
-        Button: '/components/Logout#MyComponent'
+        Button: '/components/Logout#MyComponent' // highlight-line
       }
     }
   },
 })
 ```
 
-In this example, we set the base directory to the `src` directory - thus we can omit the `/src/` part of our component path string.
+In this example, we set the base directory to the `src` directory, and omit the `/src/` part of our component path string.
 
-### Passing Props
+### Config Options
 
-Each React Component in the Payload Config is typed as `PayloadComponent`. This usually is a string, but can also be an object containing the following properties:
+While Custom Components are usually defined as a string, you can also pass in an object with additional options:
 
-| Property      | Description                                                                                                                   |
-|---------------|-------------------------------------------------------------------------------------------------------------------------------|
-| `clientProps` | Props to be passed to the React Component if it's a Client Component                                                          |
-| `exportName`  | Instead of declaring named exports using `#` in the component path, you can also omit them from `path` and pass them in here. |
-| `path`        | Path to the React Component. Named exports can be appended to the end of the path, separated by a `#`                         |
-| `serverProps` | Props to be passed to the React Component if it's a Server Component                                                          |
-
-To pass in props from the config, you can use the `clientProps` and/or `serverProps` properties. This alleviates the need to use an HOC (Higher-Order-Component) to declare a React Component with props passed in.
-
-Here is an example:
-
-src/components/Logout.tsx
-```tsx
-'use client'
-import React from 'react'
-
-export const MyComponent = ({ text }: { text: string }) => {
-  return (
-    <button>Click me! {text}</button>
-  )
-}
-```
-
-payload.config.ts:
 ```ts
 import { buildConfig } from 'payload'
 
 const config = buildConfig({
   // ...
-  admin: { // highlight-line
+  admin: {
     components: {
       logout: {
+        // highlight-start
         Button: {
           path: '/src/components/Logout',
-          clientProps: {
-            text: 'Some Text.'
-          },
-          exportName: 'MyComponent'
+          exportName: 'MyComponent',
         }
+        // highlight-end
       }
     }
   },
 })
 ```
 
-### Import Maps
+The following options are available:
 
-It's essential to understand how `PayloadComponent` paths function behind the scenes. Directly importing React Components into your Payload Config using import statements can introduce client-only modules like CSS into your server-only config. This could error when attempting to load the Payload Config in server-only environments and unnecessarily increase the size of the Payload Config, which should remain streamlined and efficient for server use.
+| Property      | Description                                                                                                                   |
+|---------------|-------------------------------------------------------------------------------------------------------------------------------|
+| **`clientProps`** | Props to be passed to the Custom Components if it's a Client Component. [More details](#custom-props).                         |
+| **`exportName`**  | Instead of declaring named exports using `#` in the component path, you can also omit them from `path` and pass them in here. |
+| **`path`**        | File path to the Custom Component. Named exports can be appended to the end of the path, separated by a `#`.                         |
+| **`serverProps`** | Props to be passed to the Custom Component if it's a Server Component. [More details](#custom-props).                         |
 
-Instead, we utilize component paths to reference React Components. This method enhances the Payload Config with actual React Component imports on the client side, without affecting server-side usage. A script is deployed to scan the Payload Config, collecting all component paths and creating an `importMap.js`. This file, located in app/(payload)/admin/importMap.js, must be statically imported by your Next.js root page and layout. The script imports all the React Components from the specified paths into a Map, associating them with their respective paths (the ones you defined).
+For more details on how to build Custom Components, see [Building Custom Components](#building-custom-components).
 
-When constructing the `ClientConfig`, Payload uses the component paths as keys to fetch the corresponding React Component imports from the Import Map. It then substitutes the `PayloadComponent` with a `MappedComponent`. A `MappedComponent` includes the React Component and additional metadata, such as whether it's a server or a client component and which props it should receive. These components are then rendered through the `<RenderComponent />` component within the Payload Admin Panel.
+### Import Map
 
-Import maps are regenerated whenever you modify any element related to component paths. This regeneration occurs at startup and whenever Hot Module Replacement (HMR) runs. If the import maps fail to regenerate during HMR, you can restart your application and execute the `payload generate:importmap` command to manually create a new import map. If you encounter any errors running this command, see the [Troubleshooting](../local-api/outside-nextjs#troubleshooting) section.
+In order for Payload to make use of [Component Paths](#component-paths), an "Import Map" is automatically generated at `app/(payload)/admin/importMap.js`. This file contains every Custom Component in your config, keyed to their respective paths. When Payload needs to lookup a component, it uses this file to find the correct import.
 
-### Component paths in external packages
+The Import Map is automatically regenerated at startup and whenever Hot Module Replacement (HMR) runs, or you can run `payload generate:importmap` to manually regenerate it.
 
-Component paths are resolved relative to your project's base directory, which is either your current working directory or the directory specified in `config.admin.baseDir`. When using custom components from external packages, you can't use relative paths. Instead, use an import path that's accessible as if you were writing an import statement in your project's base directory.
+#### Custom Imports
 
-For example, to export a field with a custom component from an external package named `my-external-package`:
+If needed, custom items can be appended onto the Import Map. This is mostly only relevant for plugin authors who need to add a custom import that is not referenced in a known location.
+
+To add a custom import to the Import Map, use the `admin.dependencies` property in your [Payload Config](../getting-started/overview):
 
 ```ts
-import type { Field } from 'payload'
-export const MyCustomField: Field = {
-  type: 'text',
-  name: 'MyField',
-  admin: {
-    components: {
-      Field: 'my-external-package/client#MyFieldComponent'
-    }
-  }
-}
-```
+import { buildConfig } from 'payload'
 
-Despite `MyFieldComponent` living in `src/components/MyFieldComponent.tsx` in `my-external-package`, this will not be accessible from the consuming project. Instead, we recommend exporting all custom components from one file in the external package. For example, you can define a `src/client.ts file in `my-external-package`:
-
-```ts
-'use client'
-export { MyFieldComponent } from './components/MyFieldComponent'
-```
-
-Then, update the package.json of `my-external-package:
-
-```json
-{
-...
-  "exports": {
-    "./client": {
-        "import": "./dist/client.js",
-        "types": "./dist/client.d.ts",
-        "default": "./dist/client.js"
-    }
-  }
-}
-```
-
-This setup allows you to specify the component path as `my-external-package/client#MyFieldComponent` as seen above. The import map will generate:
-
-```ts
-import { MyFieldComponent } from 'my-external-package/client'
-```
-
-which is a valid way to access MyFieldComponent that can be resolved by the consuming project.
-
-### Custom Components from unknown locations
-
-By default, any component paths from known locations are added to the import map. However, if you need to add any components from unknown locations to the import map, you can do so by adding them to the `admin.dependencies` array in your Payload Config. This is mostly only relevant for plugin authors and not for regular Payload users.
-
-Example:
-
-```ts
-export default {
+export default buildConfig({
   // ...
   admin: {
     // ...
@@ -220,116 +149,11 @@ export default {
 }
 ```
 
-This way, `TestComponent` is added to the import map, no matter if it's referenced in a known location or not. On the client, you can then use the component like this:
-
-```tsx
-'use client'
-
-import { RenderComponent, useConfig } from '@payloadcms/ui'
-import React from 'react'
-
-export const CustomView = () => {
-  const { config } = useConfig()
-  return (
-    <div>
-      <RenderComponent mappedComponent={config.admin.dependencies?.myTestComponent} />
-    </div>
-  )
-}
-```
-
-## Root Components
-
-Root Components are those that effect the [Admin Panel](./overview) generally, such as the logo or the main nav.
-
-To override Root Components, use the `admin.components` property in your [Payload Config](../getting-started/overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  admin: {
-    // highlight-start
-    components: {
-      // ...
-    },
-    // highlight-end
-  },
-})
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](#building-custom-components)._
-
-The following options are available:
-
-| Path                  | Description                                                                                                                                                                                                         |
-|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                                 |
-| **`beforeNavLinks`**  | An array of Custom Components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                       |
-| **`afterNavLinks`**   | An array of Custom Components to inject into the built-in Nav, _after_ the links.                                                                                                                                   |
-| **`beforeDashboard`** | An array of Custom Components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                       |
-| **`afterDashboard`**  | An array of Custom Components to inject into the built-in Dashboard, _after_ the default dashboard contents.                                                                                                        |
-| **`beforeLogin`**     | An array of Custom Components to inject into the built-in Login, _before_ the default login form.                                                                                                                   |
-| **`afterLogin`**      | An array of Custom Components to inject into the built-in Login, _after_ the default login form.                                                                                                                    |
-| **`logout.Button`**   | The button displayed in the sidebar that logs the user out.                                                                                                                                                         |
-| **`graphics.Icon`**   | The simplified logo used in contexts like the the `Nav` component.                                                                                                                                                  |
-| **`graphics.Logo`**   | The full logo used in contexts like the `Login` view.                                                                                                                                                               |
-| **`providers`**       | Custom [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context) providers that will wrap the entire Admin Panel. [More details](#custom-providers).                                       |
-| **`actions`**         | An array of Custom Components to be rendered _within_ the header of the Admin Panel, providing additional interactivity and functionality.                                                                  |
-| **`header`**          | An array of Custom Components to be injected above the Payload header.                                                   |
-| **`views`**           | Override or create new views within the Admin Panel. [More details](./views).                                                                                                                                 |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  You can also use set [Collection Components](./collections#components) and [Global Components](./globals#components) in their respective configs.
-</Banner>
-
-### Custom Providers
-
-As you add more and more Custom Components to your [Admin Panel](./overview), you may find it helpful to add additional [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context)(s). Payload allows you to inject your own context providers in your app so you can export your own custom hooks, etc.
-
-To add a Custom Provider, use the `admin.components.providers` property in your [Payload Config](../getting-started/overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  admin: {
-    components: {
-      providers: ['/path/to/MyProvider'], // highlight-line
-    },
-  },
-})
-```
-
-Then build your Custom Provider as follows:
-
-```tsx
-'use client'
-import React, { createContext, useContext } from 'react'
-
-const MyCustomContext = React.createContext(myCustomValue)
-
-export const MyProvider: React.FC = ({ children }) => {
-  return (
-    <MyCustomContext.Provider value={myCustomValue}>
-      {children}
-    </MyCustomContext.Provider>
-  )
-}
-
-export const useMyCustomContext = () => useContext(MyCustomContext)
-```
-
-<Banner type="warning">
-  <strong>Reminder:</strong> Custom Providers are by definition Client Components. This means they must include the `use client` directive at the top of their files and cannot use server-only code.
-</Banner>
-
 ## Building Custom Components
 
-All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly on the front-end, among other things.
+All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api/overview) directly on the front-end, among other things.
+
+### Default Props
 
 To make building Custom Components as easy as possible, Payload automatically provides common props, such as the [`payload`](../local-api/overview) class and the [`i18n`](../configuration/i18n) object. This means that when building Custom Components within the Admin Panel, you do not have to get these yourself.
 
@@ -359,12 +183,46 @@ Each Custom Component receives the following props by default:
 | `payload`                 | The [Payload](../local-api/overview) class.                                                           |
 | `i18n`                    | The [i18n](../configuration/i18n) object.                                                                           |
 
-Custom Components also receive various other props that are specific to the context in which the Custom Component is being rendered. For example, [Custom Views](./views) receive the `user` prop. For a full list of available props, consult the documentation related to the specific component you are working with.
-
-<Banner type="success">
-  See [Root Components](#root-components), [Collection Components](#collection-components), [Global Components](#global-components), or [Field Components](#custom-field-components) for a complete list of all available components.
+<Banner type="warning">
+  <strong>Reminder:</strong>
+  All Custom Components also receive various other props that are specific component being rendered. See [Root Components](#root-components), [Collection Components](#collection-components), [Global Components](#global-components), or [Field Components](#custom-field-components) for a complete list of all default props per component.
 </Banner>
 
+### Custom Props
+
+To pass in custom props from the config, you can use either the `clientProps` or `serverProps` properties depending on whether your prop is [serializable](https://react.dev/reference/rsc/use-client#serializable-types), and whether your component is a Server or Client Component.
+
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: { // highlight-line
+    components: {
+      logout: {
+        Button: {
+          path: '/src/components/Logout#MyComponent',
+          clientProps: {
+            myCustomProp: 'Hello, World!' // highlight-line
+          },
+        }
+      }
+    }
+  },
+})
+```
+
+```tsx
+'use client'
+import React from 'react'
+
+export const MyComponent = ({ myCustomProp }: { myCustomProp: string }) => {
+  return (
+    <button>{myCustomProp}</button>
+  )
+}
+```
+
 ### Client Components
 
 When [Building Custom Components](#building-custom-components), it's still possible to use client-side code such as `useState` or the `window` object. To do this, simply add the `use client` directive at the top of your file. Payload will automatically detect and remove all default, [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component.
@@ -414,6 +272,7 @@ But, the Payload Config is [non-serializable](https://react.dev/reference/rsc/us
 For this reason, Payload creates a Client Config and passes it into the Config Provider. This is a serializable version of the Payload Config that can be accessed from any Client Component via the [`useConfig`](./hooks#useconfig) hook:
 
 ```tsx
+'use client'
 import React from 'react'
 import { useConfig } from '@payloadcms/ui'
 
@@ -432,14 +291,13 @@ export const MyClientComponent: React.FC = () => {
   See [Using Hooks](#using-hooks) for more details.
 </Banner>
 
-All [Field Components](./fields) automatically receive their respective Field Config through a common [`field`](./fields#the-field-prop) prop:
+All [Field Components](./fields) automatically receive their respective Field Config through props.
 
 ```tsx
-'use client'
 import React from 'react'
-import type { TextFieldClientComponent } from 'payload'
+import type { TextFieldServerComponent } from 'payload'
 
-export const MyClientFieldComponent: TextFieldClientComponent = ({ field: { name } }) => {
+export const MyClientFieldComponent: TextFieldServerComponent = ({ field: { name } }) => {
   return (
     <p>
       {`This field's name is ${name}`}
@@ -448,28 +306,6 @@ export const MyClientFieldComponent: TextFieldClientComponent = ({ field: { name
 }
 ```
 
-### Using Hooks
-
-To make it easier to [build your Custom Components](#building-custom-components), you can use [Payload's built-in React Hooks](./hooks) in any Client Component. For example, you might want to interact with one of Payload's many React Contexts:
-
-```tsx
-'use client'
-import React from 'react'
-import { useDocumentInfo } from '@payloadcms/ui'
-
-export const MyClientComponent: React.FC = () => {
-  const { slug } = useDocumentInfo() // highlight-line
-
-  return (
-    <p>{`Entity slug: ${slug}`}</p>
-  )
-}
-```
-
-<Banner type="success">
-  See the [Hooks](./hooks) documentation for a full list of available hooks.
-</Banner>
-
 ### Getting the Current Language
 
 All Custom Components can support multiple languages to be consistent with Payload's [Internationalization](../configuration/i18n). To do this, first add your translation resources to the [I18n Config](../configuration/i18n).
@@ -492,6 +328,7 @@ export default async function MyServerComponent({ i18n }) {
 The best way to do this within a Client Component is to import the `useTranslation` hook from `@payloadcms/ui`:
 
 ```tsx
+'use client'
 import React from 'react'
 import { useTranslation } from '@payloadcms/ui'
 
@@ -535,6 +372,7 @@ export default async function MyServerComponent({ payload, locale }) {
 The best way to do this within a Client Component is to import the `useLocale` hook from `@payloadcms/ui`:
 
 ```tsx
+'use client'
 import React from 'react'
 import { useLocale } from '@payloadcms/ui'
 
@@ -556,7 +394,29 @@ const Greeting: React.FC = () => {
   See the [Hooks](./hooks) documentation for a full list of available hooks.
 </Banner>
 
-### Styling Custom Components
+### Using Hooks
+
+To make it easier to [build your Custom Components](#building-custom-components), you can use [Payload's built-in React Hooks](./hooks) in any Client Component. For example, you might want to interact with one of Payload's many React Contexts. To do this, you can one of the many hooks available depending on your needs.
+
+```tsx
+'use client'
+import React from 'react'
+import { useDocumentInfo } from '@payloadcms/ui'
+
+export const MyClientComponent: React.FC = () => {
+  const { slug } = useDocumentInfo() // highlight-line
+
+  return (
+    <p>{`Entity slug: ${slug}`}</p>
+  )
+}
+```
+
+<Banner type="success">
+  See the [Hooks](./hooks) documentation for a full list of available hooks.
+</Banner>
+
+### Adding Styles
 
 Payload has a robust [CSS Library](./customizing-css) that you can use to style your Custom Components similarly to Payload's built-in styling. This will ensure that your Custom Components match the existing design system, and so that they automatically adapt to any theme changes that might occur.
 
@@ -592,10 +452,99 @@ Payload also exports its [SCSS](https://sass-lang.com) library for reuse which i
     background-color: var(--theme-elevation-900);
   }
 }
-
 ```
 
 <Banner type="success">
   <strong>Note:</strong>
   You can also drill into Payload's own component styles, or easily apply global, app-wide CSS. More on that [here](./customizing-css).
 </Banner>
+
+
+## Root Components
+
+Root Components are those that effect the [Admin Panel](./overview) generally, such as the logo or the main nav.
+
+To override Root Components, use the `admin.components` property in your [Payload Config](../getting-started/overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  admin: {
+    // highlight-start
+    components: {
+      // ...
+    },
+    // highlight-end
+  },
+})
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](#building-custom-components)._
+
+The following options are available:
+
+| Path                  | Description                                                                                                                                                                                                         |
+|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                                 |
+| **`beforeNavLinks`**  | An array of Custom Components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                       |
+| **`afterNavLinks`**   | An array of Custom Components to inject into the built-in Nav, _after_ the links.                                                                                                                                   |
+| **`beforeDashboard`** | An array of Custom Components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                       |
+| **`afterDashboard`**  | An array of Custom Components to inject into the built-in Dashboard, _after_ the default dashboard contents.                                                                                                        |
+| **`beforeLogin`**     | An array of Custom Components to inject into the built-in Login, _before_ the default login form.                                                                                                                   |
+| **`afterLogin`**      | An array of Custom Components to inject into the built-in Login, _after_ the default login form.                                                                                                                    |
+| **`logout.Button`**   | The button displayed in the sidebar that logs the user out.                                                                                                                                                         |
+| **`graphics.Icon`**   | The simplified logo used in contexts like the the `Nav` component.                                                                                                                                                  |
+| **`graphics.Logo`**   | The full logo used in contexts like the `Login` view.                                                                                                                                                               |
+| **`providers`**       | Custom [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context) providers that will wrap the entire Admin Panel. [More details](#custom-providers).                                       |
+| **`actions`**         | An array of Custom Components to be rendered _within_ the header of the Admin Panel, providing additional interactivity and functionality.                                                                  |
+| **`header`**          | An array of Custom Components to be injected above the Payload header.                                                   |
+| **`views`**           | Override or create new views within the Admin Panel. [More details](./views).                                                                                                                                 |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  You can also use set [Collection Components](./collections#custom-components) and [Global Components](./globals#custom-components) in their respective configs.
+</Banner>
+
+### Custom Providers
+
+As you add more and more Custom Components to your [Admin Panel](./overview), you may find it helpful to add additional [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context)(s). Payload allows you to inject your own context providers in your app so you can export your own custom hooks, etc.
+
+To add a Custom Provider, use the `admin.components.providers` property in your [Payload Config](../getting-started/overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  admin: {
+    components: {
+      providers: ['/path/to/MyProvider'], // highlight-line
+    },
+  },
+})
+```
+
+Then build your Custom Provider as follows:
+
+```tsx
+'use client'
+import React, { createContext, useContext } from 'react'
+
+const MyCustomContext = React.createContext(myCustomValue)
+
+export const MyProvider: React.FC = ({ children }) => {
+  return (
+    <MyCustomContext.Provider value={myCustomValue}>
+      {children}
+    </MyCustomContext.Provider>
+  )
+}
+
+export const useMyCustomContext = () => useContext(MyCustomContext)
+```
+
+<Banner type="warning">
+  <strong>Reminder:</strong> Custom Providers are by definition Client Components. This means they must include the `use client` directive at the top of their files and cannot use server-only code.
+</Banner>

docs/admin/fields.mdx

@@ -6,7 +6,7 @@ desc:
 keywords:
 ---
 
-[Fields](../fields/overview) within the [Admin Panel](./overview) can be endlessly customized in their appearance and behavior without affecting their underlying data structure. Fields are designed to withstand heavy modification or even complete replacement through the use of [Custom Field Components](#field-components), [Conditional Logic](#conditional-logic), [Custom Validations](../fields/overview#validation), and more.
+[Fields](../fields/overview) within the [Admin Panel](./overview) can be endlessly customized in their appearance and behavior without affecting their underlying data structure. Fields are designed to withstand heavy modification or even complete replacement through the use of [Custom Field Components](#custom-components), [Conditional Logic](#conditional-logic), [Custom Validations](../fields/overview#validation), and more.
 
 For example, your app might need to render a specific interface that Payload does not inherently support, such as a color picker. To do this, you could replace the default [Text Field](../fields/text) input with your own user-friendly component that formats the data into a valid color value.
 
@@ -56,335 +56,7 @@ The following options are available:
 | **`disableListFilter`** | Set `disableListFilter` to `true` to prevent fields from appearing in the list view filter options.                                                                                                                              |
 | **`hidden`**            | Will transform the field into a `hidden` input type. Its value will still submit with requests in the Admin Panel, but the field itself will not be visible to editors.                                                          |
 
-## Field Components
-
-Within the [Admin Panel](./overview), fields are rendered in three distinct places:
-
-- [Field](#the-field-component) - The actual form field rendered in the Edit View.
-- [Cell](#the-cell-component) - The table cell component rendered in the List View.
-- [Filter](#the-filter-component) - The filter component rendered in the List View.
-
-To easily swap in Field Components with your own, use the `admin.components` property in your [Field Config](../fields/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionConfig: CollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      // ...
-      admin: {
-        components: { // highlight-line
-          // ...
-        },
-      },
-    }
-  ]
-}
-```
-
-The following options are available:
-
-| Component    | Description                                                                                                                 |
-| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
-| **`Field`**  | The form field rendered of the Edit View. [More details](#the-field-component).                                                |
-| **`Cell`**   | The table cell rendered of the List View. [More details](#the-cell-component).              |
-| **`Filter`** | The filter component rendered in the List View. [More details](#the-filter-component). || Component         | Description                                                                                                     |
-| **`Label`**       | Override the default Label of the Field Component. [More details](#the-label-component).                                    |
-| **`Error`**       | Override the default Error of the Field Component. [More details](#the-error-component).                                    |
-| **`Description`** | Override the default Description of the Field Component. [More details](#the-description-component).                      |
-| **`beforeInput`** | An array of elements that will be added before the input of the Field Component. [More details](#afterinput-and-beforeinput).|
-| **`afterInput`**  | An array of elements that will be added after the input of the Field Component. [More details](#afterinput-and-beforeinput). |
-
-_\* **`beforeInput`** and **`afterInput`** are only supported in fields that do not contain other fields, such as [`Text`](../fields/text), and [`Textarea`](../fields/textarea)._
-
-### The Field Component
-
-The Field Component is the actual form field rendered in the Edit View. This is the input that user's will interact with when editing a document.
-
-To easily swap in your own Field Component, use the `admin.components.Field` property in your [Field Config](../fields/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionConfig: CollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      // ...
-      admin: {
-        components: {
-          Field: '/path/to/MyFieldComponent', // highlight-line
-        },
-      },
-    }
-  ]
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-<Banner type="warning">
-  Instead of replacing the entire Field Component, you can alternately replace or slot-in only specific parts by using the [`Label`](#the-label-component), [`Error`](#the-error-component), [`beforeInput`](#afterinput-and-beforinput), and [`afterInput`](#afterinput-and-beforinput) properties.
-</Banner>
-
-All Field Components receive the following props:
-
-| Property         | Description                                                                                                                                                                                                                      |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`docPreferences`** | An object that contains the [Preferences](./preferences) for the document.
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-| **`locale`**     | The locale of the field. [More details](../configuration/localization).                                                                                                                                                                   |
-| **`readOnly`**   | A boolean value that represents if the field is read-only or not.                                                                                                                                                                  |
-| **`user`**       | The currently authenticated user. [More details](../authentication/overview). |
-| **`validate`**   | A function that can be used to validate the field.                                                                                                                                                                                 |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### Sending and receiving values from the form
-
-When swapping out the `Field` component, you are responsible for sending and receiving the field's `value` from the form itself.
-
-To do so, import the [`useField`](./hooks#usefield) hook from `@payloadcms/ui` and use it to manage the field's value:
-
-```tsx
-'use client'
-import { useField } from '@payloadcms/ui'
-
-export const CustomTextField: React.FC = () => {
-  const { value, setValue } = useField() // highlight-line
-
-  return (
-    <input
-      onChange={(e) => setValue(e.target.value)}
-      value={value}
-    />
-  )
-}
-```
-
-<Banner type="success">
-  For a complete list of all available React hooks, see the [Payload React Hooks](./hooks) documentation. For additional help, see [Building Custom Components](./components#building-custom-components).
-</Banner>
-
-#### TypeScript
-
-When building Custom Field Components, you can import the component type to ensure type safety. There is an explicit type for the Field Component, one for every [Field Type](../fields/overview) and for every client/server environment. The convention is to prepend the field type onto the target type, i.e. `TextFieldClientComponent`:
-
-```tsx
-import type {
-  TextFieldClientComponent,
-  TextFieldServerComponent,
-  TextFieldClientProps,
-  TextFieldServerProps,
-  // ...and so on for each Field Type
-} from 'payload'
-```
-
-### The `field` Prop
-
-All Field Components are passed their own Field Config through a common `field` prop. Within Server Components, this is the original Field Config as written within your Payload Config. Within Client Components, however, this is a "Client Config", which is a sanitized, client-friendly version of the Field Config. This is because the original Field Config is [non-serializable](https://react.dev/reference/rsc/use-client#serializable-types), meaning it cannot be passed into Client Components without first being transformed.
-
-The Client Field Config is an exact copy of the original Field Config, minus all non-serializable properties, plus all evaluated functions such as field labels, [Custom Components](../components), etc.
-
-Server Component:
-
-```tsx
-import React from 'react'
-import type { TextFieldServerComponent } from 'payload'
-import { TextField } from '@payloadcms/ui'
-
-export const MyServerField: TextFieldServerComponent = ({ clientField }) => {
-  return <TextField field={clientField} />
-}
-```
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  Server Components can still access the original Field Config through the `field` prop.
-</Banner>
-
-Client Component:
-
-```tsx
-'use client'
-import React from 'react'
-import type { TextFieldClientComponent } from 'payload'
-import { TextField } from '@payloadcms/ui'
-
-export const MyTextField: TextFieldClientComponent = ({ field }) => {
-  return <TextField field={field} />
-}
-```
-
-The following additional properties are also provided to the `field` prop:
-
-| Property         | Description                                                                                                                                                                                                                      |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`_isPresentational`** | A boolean indicating that the field is purely visual and does not directly affect data or change data shape, i.e. the [UI Field](../fields/ui). |
-| **`_path`** | A string representing the direct, dynamic path to the field at runtime, i.e. `myGroup.myArray[0].myField`. |
-| **`_schemaPath`** | A string representing the direct, static path to the [Field Config](../fields/overview), i.e. `myGroup.myArray.myField` |
-
-<Banner type="info">
-  <strong>Note:</strong>
-  These properties are underscored to denote that they are not part of the original Field Config, and instead are attached during client sanitization to make fields easier to work with on the front-end.
-</Banner>
-
-#### TypeScript
-
-When building Custom Field Components, you can import the client field props to ensure type safety in your component. There is an explicit type for the Field Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to prepend the field type onto the target type, i.e. `TextFieldClientComponent`:
-
-```tsx
-import type {
-  TextFieldClientComponent,
-  TextFieldServerComponent,
-  TextFieldClientProps,
-  TextFieldServerProps,
-  // ...and so on for each Field Type
-} from 'payload'
-```
-
-### The Cell Component
-
-The Cell Component is rendered in the table of the List View. It represents the value of the field when displayed in a table cell.
-
-To easily swap in your own Cell Component, use the `admin.components.Cell` property in your [Field Config](../fields/overview):
-
-```ts
-import type { Field } from 'payload'
-
-export const myField: Field = {
-  name: 'myField',
-  type: 'text',
-  admin: {
-    components: {
-      Cell: '/path/to/MyCustomCellComponent', // highlight-line
-    },
-  },
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-All Cell Components receive the following props:
-
-| Property         | Description                                                       |
-| ---------------- | ----------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-| **`link`** | A boolean representing whether this cell should be wrapped in a link. |
-| **`onClick`** | A function that is called when the cell is clicked. |
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  Use the [`useTableCell`](./hooks#usetablecell) hook to subscribe to the field's `cellData` and `rowData`.
-</Banner>
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-### The Label Component
-
-The Label Component is rendered anywhere a field needs to be represented by a label. This is typically used in the Edit View, but can also be used in the List View and elsewhere.
-
-To easily swap in your own Label Component, use the `admin.components.Label` property in your [Field Config](../fields/overview):
-
-```ts
-import type { Field } from 'payload'
-
-export const myField: Field = {
-  name: 'myField',
-  type: 'text',
-  admin: {
-    components: {
-      Label: '/path/to/MyCustomLabelComponent', // highlight-line
-    },
-  },
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-Custom Label Components receive all [Field Component](#the-field-component) props, plus the following props:
-
-| Property       | Description                                                      |
-| -------------- | ---------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### TypeScript
-
-When building Custom Label Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Label Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `LabelServerComponent` or `LabelClientComponent` to the type of field, i.e. `TextFieldLabelClientComponent`.
-
-```tsx
-import type {
-  TextFieldLabelServerComponent,
-  TextFieldLabelClientComponent,
-  // ...and so on for each Field Type
-} from 'payload'
-```
-
-### The Error Component
-
-The Error Component is rendered when a field fails validation. It is typically displayed beneath the field input in a visually-compelling style.
-
-To easily swap in your own Error Component, use the `admin.components.Error` property in your [Field Config](../fields/overview):
-
-```ts
-import type { Field } from 'payload'
-
-export const myField: Field = {
-  name: 'myField',
-  type: 'text',
-  admin: {
-    components: {
-      Error: '/path/to/MyCustomErrorComponent', // highlight-line
-    },
-  },
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-Custom Error Components receive all [Field Component](#the-field-component) props, plus the following props:
-
-| Property        | Description                                                   |
-| --------------- | ------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### TypeScript
-
-When building Custom Error Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Error Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `ErrorServerComponent` or `ErrorClientComponent` to the type of field, i.e. `TextFieldErrorClientComponent`.
-
-```tsx
-import type {
-  TextFieldErrorServerComponent,
-  TextFieldErrorClientComponent,
-  // And so on for each Field Type
-} from 'payload'
-```
-
-### The Description Property
+## Field Descriptions
 
 Field Descriptions are used to provide additional information to the editor about a field, such as special instructions. Their placement varies from field to field, but typically are displayed with subtle style differences beneath the field inputs.
 
@@ -392,7 +64,7 @@ A description can be configured in three ways:
 
   - As a string.
   - As a function which returns a string. [More details](#description-functions).
-  - As a React component. [More details](#the-description-component).
+  - As a React component. [More details](#description).
 
 To easily add a Custom Description to a field, use the `admin.description` property in your [Field Config](../fields/overview):
 
@@ -416,7 +88,7 @@ export const MyCollectionConfig: SanitizedCollectionConfig = {
 
 <Banner type="warning">
   <strong>Reminder:</strong>
-  To replace the Field Description with a [Custom Component](./components), use the `admin.components.Description` property. [More details](#the-description-component).
+  To replace the Field Description with a [Custom Component](./components), use the `admin.components.Description` property. [More details](#description).
 </Banner>
 
 #### Description Functions
@@ -449,89 +121,6 @@ All Description Functions receive the following arguments:
 | -------------- | ---------------------------------------------------------------- |
 | **`t`**        | The `t` function used to internationalize the Admin Panel. [More details](../configuration/i18n) |
 
-### The Description Component
-
-Alternatively to the [Description Property](#the-description-property), you can also use a [Custom Component](./components) as the Field Description. This can be useful when you need to provide more complex feedback to the user, such as rendering dynamic field values or other interactive elements.
-
-To easily add a Description Component to a field, use the `admin.components.Description` property in your [Field Config](../fields/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      name: 'myField',
-      type: 'text',
-      admin: {
-        components: {
-          Description: '/path/to/MyCustomDescriptionComponent', // highlight-line
-        }
-      }
-    }
-  ]
-}
-```
-
-_For details on how to build a Custom Description, see [Building Custom Components](./components#building-custom-components)._
-
-Custom Description Components receive all [Field Component](#the-field-component) props, plus the following props:
-
-| Property       | Description                                                      |
-| -------------- | ---------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### TypeScript
-
-When building Custom Description Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Description Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `DescriptionServerComponent` or `DescriptionClientComponent` to the type of field, i.e. `TextFieldDescriptionClientComponent`.
-
-```tsx
-import type {
-  TextFieldDescriptionServerComponent,
-  TextFieldDescriptionClientComponent,
-  // And so on for each Field Type
-} from 'payload'
-```
-
-### afterInput and beforeInput
-
-With these properties you can add multiple components _before_ and _after_ the input element, as their name suggests. This is useful when you need to render additional elements alongside the field without replacing the entire field component.
-
-To add components before and after the input element, use the `admin.components.beforeInput` and `admin.components.afterInput` properties in your [Field Config](../fields/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      name: 'myField',
-      type: 'text',
-      admin: {
-        components: {
-          // highlight-start
-          beforeInput: ['/path/to/MyCustomComponent'],
-          afterInput: ['/path/to/MyOtherCustomComponent'],
-          // highlight-end
-        }
-      }
-    }
-  ]
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
 ## Conditional Logic
 
 You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes three arguments:
@@ -570,3 +159,322 @@ The `condition` function should return a boolean that will control if the field
   ]
 }
 ```
+
+## Custom Components
+
+Within the [Admin Panel](./overview), fields are represented in three distinct places:
+
+- [Field](#field) - The actual form field rendered in the Edit View.
+- [Cell](#cell) - The table cell component rendered in the List View.
+- [Filter](#filter) - The filter component rendered in the List View.
+
+To easily swap in Field Components with your own, use the `admin.components` property in your [Field Config](../fields/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionConfig: CollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      // ...
+      admin: {
+        components: { // highlight-line
+          // ...
+        },
+      },
+    }
+  ]
+}
+```
+
+The following options are available:
+
+| Component    | Description                                                                                                                 |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
+| **`Field`**  | The form field rendered of the Edit View. [More details](#field).                                                |
+| **`Cell`**   | The table cell rendered of the List View. [More details](#cell).              |
+| **`Filter`** | The filter component rendered in the List View. [More details](#filter). |
+| **`Label`**       | Override the default Label of the Field Component. [More details](#label).                                    |
+| **`Error`**       | Override the default Error of the Field Component. [More details](#error).                                    |
+| **`Description`** | Override the default Description of the Field Component. [More details](#description).                      |
+| **`beforeInput`** | An array of elements that will be added before the input of the Field Component. [More details](#afterinput-and-beforeinput).|
+| **`afterInput`**  | An array of elements that will be added after the input of the Field Component. [More details](#afterinput-and-beforeinput). |
+
+### Field
+
+The Field Component is the actual form field rendered in the Edit View. This is the input that user's will interact with when editing a document.
+
+To easily swap in your own Field Component, use the `admin.components.Field` property in your [Field Config](../fields/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionConfig: CollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      // ...
+      admin: {
+        components: {
+          Field: '/path/to/MyFieldComponent', // highlight-line
+        },
+      },
+    }
+  ]
+}
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
+
+<Banner type="warning">
+  Instead of replacing the entire Field Component, you can alternately replace or slot-in only specific parts by using the [`Label`](#label), [`Error`](#error), [`beforeInput`](#afterinput-and-beforinput), and [`afterInput`](#afterinput-and-beforinput) properties.
+</Banner>
+
+#### Default Props
+
+All Field Components receive the following props by default:
+
+| Property         | Description                                                                                                                                                                                                                      |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`docPreferences`** | An object that contains the [Preferences](./preferences) for the document.
+| **`field`** | In Client Components, this is the sanitized Client Field Config. In Server Components, this is the original Field Config. Server Components will also receive the sanitized field config through the`clientField` prop (see below). |
+| **`locale`**     | The locale of the field. [More details](../configuration/localization).                                                                                                                                                                   |
+| **`readOnly`**   | A boolean value that represents if the field is read-only or not.                                                                                                                                                                  |
+| **`user`**       | The currently authenticated user. [More details](../authentication/overview). |
+| **`validate`**   | A function that can be used to validate the field.                                                                                                                                                                                 |
+| **`path`**       | A string representing the direct, dynamic path to the field at runtime, i.e. `myGroup.myArray.0.myField`. |
+| **`schemaPath`** | A string representing the direct, static path to the [Field Config](../fields/overview), i.e. `posts.myGroup.myArray.myField`. |
+| **`indexPath`**  | A hyphen-notated string representing the path to the field _within the nearest named ancestor field_, i.e. `0-0` |
+
+In addition to the above props, all Server Components will also receive the following props:
+
+| Property         | Description                                                                                                                                                                                                                      |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`clientField`** | The serializable Client Field Config. |
+| **`field`** | The Field Config. [More details](../fields/overview). |
+| **`data`**       | The current document being edited.                                                                                                                                                                                                   |
+| **`i18n`**       | The [i18n](../configuration/i18n) object.
+| **`payload`**    | The [Payload](../local-api/overview) class.                                                           |
+| **`permissions`** | The field permissions based on the currently authenticated user.                                                                                                                                                                                                   |
+| **`siblingData`** | The data of the field's siblings.                                                                                                                                                                                                   |
+| **`user`**       | The currently authenticated user. [More details](../authentication/overview). |
+| **`value`**      | The value of the field at render-time.                                                                                                                                                                                                   |
+
+#### Sending and receiving values from the form
+
+When swapping out the `Field` component, you are responsible for sending and receiving the field's `value` from the form itself.
+
+To do so, import the [`useField`](./hooks#usefield) hook from `@payloadcms/ui` and use it to manage the field's value:
+
+```tsx
+'use client'
+import { useField } from '@payloadcms/ui'
+
+export const CustomTextField: React.FC = () => {
+  const { value, setValue } = useField() // highlight-line
+
+  return (
+    <input
+      onChange={(e) => setValue(e.target.value)}
+      value={value}
+    />
+  )
+}
+```
+
+<Banner type="success">
+  For a complete list of all available React hooks, see the [Payload React Hooks](./hooks) documentation. For additional help, see [Building Custom Components](./components#building-custom-components).
+</Banner>
+
+#### TypeScript
+
+When building Custom Field Components, you can import the client field props to ensure type safety in your component. There is an explicit type for the Field Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to prepend the field type onto the target type, i.e. `TextFieldClientComponent`:
+
+```tsx
+import type {
+  TextFieldClientComponent,
+  TextFieldServerComponent,
+  TextFieldClientProps,
+  TextFieldServerProps,
+  // ...and so on for each Field Type
+} from 'payload'
+```
+
+### Cell
+
+The Cell Component is rendered in the table of the List View. It represents the value of the field when displayed in a table cell.
+
+To easily swap in your own Cell Component, use the `admin.components.Cell` property in your [Field Config](../fields/overview):
+
+```ts
+import type { Field } from 'payload'
+
+export const myField: Field = {
+  name: 'myField',
+  type: 'text',
+  admin: {
+    components: {
+      Cell: '/path/to/MyCustomCellComponent', // highlight-line
+    },
+  },
+}
+```
+
+All Cell Components receive the same [Default Field Component Props](#field), plus the following:
+
+| Property         | Description                                                       |
+| ---------------- | ----------------------------------------------------------------- |
+| **`link`** | A boolean representing whether this cell should be wrapped in a link. |
+| **`onClick`** | A function that is called when the cell is clicked. |
+
+For details on how to build Custom Components themselves, see [Building Custom Components](./components#building-custom-components).
+
+### Label
+
+The Label Component is rendered anywhere a field needs to be represented by a label. This is typically used in the Edit View, but can also be used in the List View and elsewhere.
+
+To easily swap in your own Label Component, use the `admin.components.Label` property in your [Field Config](../fields/overview):
+
+```ts
+import type { Field } from 'payload'
+
+export const myField: Field = {
+  name: 'myField',
+  type: 'text',
+  admin: {
+    components: {
+      Label: '/path/to/MyCustomLabelComponent', // highlight-line
+    },
+  },
+}
+```
+
+All Custom Label Components receive the same [Default Field Component Props](#field).
+
+For details on how to build Custom Components themselves, see [Building Custom Components](./components#building-custom-components).
+
+#### TypeScript
+
+When building Custom Label Components, you can import the component types to ensure type safety in your component. There is an explicit type for the Label Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `LabelServerComponent` or `LabelClientComponent` to the type of field, i.e. `TextFieldLabelClientComponent`.
+
+```tsx
+import type {
+  TextFieldLabelServerComponent,
+  TextFieldLabelClientComponent,
+  // ...and so on for each Field Type
+} from 'payload'
+```
+
+### Description
+
+Alternatively to the [Description Property](#the-description-property), you can also use a [Custom Component](./components) as the Field Description. This can be useful when you need to provide more complex feedback to the user, such as rendering dynamic field values or other interactive elements.
+
+To easily add a Description Component to a field, use the `admin.components.Description` property in your [Field Config](../fields/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      name: 'myField',
+      type: 'text',
+      admin: {
+        components: {
+          Description: '/path/to/MyCustomDescriptionComponent', // highlight-line
+        }
+      }
+    }
+  ]
+}
+```
+
+All Custom Description Components receive the same [Default Field Component Props](#field).
+
+For details on how to build a Custom Components themselves, see [Building Custom Components](./components#building-custom-components).
+
+#### TypeScript
+
+When building Custom Description Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Description Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `DescriptionServerComponent` or `DescriptionClientComponent` to the type of field, i.e. `TextFieldDescriptionClientComponent`.
+
+```tsx
+import type {
+  TextFieldDescriptionServerComponent,
+  TextFieldDescriptionClientComponent,
+  // And so on for each Field Type
+} from 'payload'
+```
+
+### Error
+
+The Error Component is rendered when a field fails validation. It is typically displayed beneath the field input in a visually-compelling style.
+
+To easily swap in your own Error Component, use the `admin.components.Error` property in your [Field Config](../fields/overview):
+
+```ts
+import type { Field } from 'payload'
+
+export const myField: Field = {
+  name: 'myField',
+  type: 'text',
+  admin: {
+    components: {
+      Error: '/path/to/MyCustomErrorComponent', // highlight-line
+    },
+  },
+}
+```
+
+All Error Components receive the [Default Field Component Props](#field).
+
+For details on how to build Custom Components themselves, see [Building Custom Components](./components#building-custom-components).
+
+#### TypeScript
+
+When building Custom Error Components, you can import the component types to ensure type safety in your component. There is an explicit type for the Error Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `ErrorServerComponent` or `ErrorClientComponent` to the type of field, i.e. `TextFieldErrorClientComponent`.
+
+```tsx
+import type {
+  TextFieldErrorServerComponent,
+  TextFieldErrorClientComponent,
+  // And so on for each Field Type
+} from 'payload'
+```
+
+### afterInput and beforeInput
+
+With these properties you can add multiple components _before_ and _after_ the input element, as their name suggests. This is useful when you need to render additional elements alongside the field without replacing the entire field component.
+
+To add components before and after the input element, use the `admin.components.beforeInput` and `admin.components.afterInput` properties in your [Field Config](../fields/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      name: 'myField',
+      type: 'text',
+      admin: {
+        components: {
+          // highlight-start
+          beforeInput: ['/path/to/MyCustomComponent'],
+          afterInput: ['/path/to/MyOtherCustomComponent'],
+          // highlight-end
+        }
+      }
+    }
+  ]
+}
+```
+
+All `afterInput` and `beforeInput` Components receive the same [Default Field Component Props](#field).
+
+For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components).

docs/admin/globals.mdx

@@ -29,13 +29,13 @@ The following options are available:
 | ------------- | --------------------------------------------------------------------------------------------------------------------------------- |
 | **`group`**       | Text used as a label for grouping Collection and Global links together in the navigation.                                         |
 | **`hidden`**      | Set to true or a function, called with the current user, returning true to exclude this Global from navigation and admin routing. |
-| **`components`**  | Swap in your own React components to be used within this Global. [More details](#components).                           |
+| **`components`**  | Swap in your own React components to be used within this Global. [More details](#custom-components).                           |
 | **`preview`**     | Function to generate a preview URL within the Admin Panel for this Global that can point to your app. [More details](#preview).           |
 | **`livePreview`** | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).          |
 | **`hideAPIURL`**  | Hides the "API URL" meta field while editing documents within this collection.                                                    |
 | **`meta`**        | Page metadata overrides to apply to this Global within the Admin Panel. [More details](./metadata).                                                                           |
 
-### Components
+### Custom Components
 
 Globals can set their own [Custom Components](./components) which only apply to [Global](../configuration/globals)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
 

docs/admin/hooks.mdx

@@ -21,10 +21,11 @@ To do so, import the `useField` hook as follows:
 
 ```tsx
 'use client'
+import type { TextFieldClientComponent } from 'payload'
 import { useField } from '@payloadcms/ui'
 
-const CustomTextField: React.FC = () => {
-  const { value, setValue, path } = useField() // highlight-line
+export const CustomTextField: TextFieldClientComponent = ({ path }) => {
+  const { value, setValue } = useField({ path }) // highlight-line
 
   return (
     <div>
@@ -44,7 +45,7 @@ The `useField` hook accepts the following arguments:
 
 | Property          | Description                                                                                                                                                                                                                   |
 | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `path`            | If you do not provide a `path` or a `name`, this hook will look for one using the [`useFieldProps`](#usefieldprops) hook.                                                                                                                         |
+| `path`            | If you do not provide a `path`, `name` will be used instead. This is the path to the field in the form data.                                                                                                                  |
 | `validate`        | A validation function executed client-side _before_ submitting the form to the server. Different than [Field-level Validation](../fields/overview#validation) which runs strictly on the server. |
 | `disableFormData` | If `true`, the field will not be included in the form data when the form is submitted.                                                                                                                                         |
 | `hasRows` | If `true`, the field will be treated as a field with rows. This is useful for fields like `array` and `blocks`.                                                                                                                                         |
@@ -72,32 +73,6 @@ type FieldType<T> = {
 }
 ```
 
-## useFieldProps
-
-[Custom Field Components](./fields#the-field-component) can be rendered on the server. When using a server component as a custom field component, you can access dynamic props from within any client component rendered by your custom server component. This is done using the `useFieldProps` hook. This is important because some fields can be dynamic, such as when nested in an [`array`](../fields/array) or [`blocks`](../fields/block) field. For example, items can be added, re-ordered, or deleted on-the-fly.
-
-You can use the `useFieldProps` hooks to access dynamic props like `path`:
-
-```tsx
-'use client'
-import { useFieldProps } from '@payloadcms/ui'
-
-const CustomTextField: React.FC = () => {
-  const { path } = useFieldProps() // highlight-line
-
-  return (
-    <div>
-      {path}
-    </div>
-  )
-}
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  The [`useField`](#usefield) hook calls the `useFieldProps` hook internally, so you don't need to use both in the same component unless explicitly needed.
-</Banner>
-
 ## useFormFields
 
 There are times when a custom field component needs to have access to data from other fields, and you have a few options to do so. The `useFormFields` hook is a powerful and highly performant way to retrieve a form's field state, as well as to retrieve the `dispatchFields` method, which can be helpful for setting other fields' form states from anywhere within a form.
@@ -760,7 +735,7 @@ const LinkFromCategoryToPosts: React.FC = () => {
 
 ## useLocale
 
-In any Custom Component you can get the selected locale object with the `useLocale` hook. `useLocale`gives you the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
+In any Custom Component you can get the selected locale object with the `useLocale` hook. `useLocale` gives you the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
 
 ```tsx
 'use client'
@@ -900,27 +875,6 @@ const MyComponent: React.FC = () => {
 }
 ```
 
-## useTableCell
-
-Similar to [`useFieldProps`](#usefieldprops), all [Custom Cell Components](./fields#the-cell-component) are rendered on the server, and as such, only have access to static props at render time. But, some props need to be dynamic, such as the field value itself.
-
-For this reason, dynamic props like `cellData` are managed in their own React context, which can be accessed using the `useTableCell` hook.
-
-```tsx
-'use client'
-import { useTableCell } from '@payloadcms/ui'
-
-const MyComponent: React.FC = () => {
-  const { cellData } = useTableCell() // highlight-line
-
-  return (
-    <div>
-      {cellData}
-    </div>
-  )
-}
-```
-
 ## useDocumentEvents
 
 The `useDocumentEvents` hook provides a way of subscribing to cross-document events, such as updates made to nested documents within a drawer. This hook will report document events that are outside the scope of the document currently being edited. This hook provides the following:

docs/admin/locked-documents.mdx

@@ -2,7 +2,7 @@
 title: Document Locking
 label: Document Locking
 order: 90
-desc: Ensure your documents are locked while being edited, preventing concurrent edits from multiple users and preserving data integrity.
+desc: Ensure your documents are locked during editing to prevent concurrent changes from multiple users and maintain data integrity.
 keywords: locking, document locking, edit locking, document, concurrency, Payload, headless, Content Management System, cms, javascript, react, node, nextjs
 ---
 
@@ -12,19 +12,19 @@ The lock is automatically triggered when a user begins editing a document within
 
 ## How it works
 
-When a user starts editing a document, Payload locks the document for that user. If another user tries to access the same document, they will be notified that it is currently being edited and can choose one of the following options:
+When a user starts editing a document, Payload locks it for that user. If another user attempts to access the same document, they will be notified that it is currently being edited. They can then choose one of the following options:
 
-- View in Read-Only Mode: View the document without making any changes.
-- Take Over Editing: Take over editing from the current user, which locks the document for the new editor and notifies the original user.
+- View in Read-Only: View the document without the ability to make any changes.
+- Take Over: Take over editing from the current user, which locks the document for the new editor and notifies the original user.
 - Return to Dashboard: Navigate away from the locked document and continue with other tasks.
 
-The lock will automatically expire after a set period of inactivity, configurable using the duration property in the lockDocuments configuration, after which others can resume editing.
+The lock will automatically expire after a set period of inactivity, configurable using the `duration` property in the `lockDocuments` configuration, after which others can resume editing.
 
-<Banner type="info"> <strong>Note:</strong> If your application does not require document locking, you can disable this feature for any collection by setting the <code>lockDocuments</code> property to <code>false</code>. </Banner>
+<Banner type="info"> <strong>Note:</strong> If your application does not require document locking, you can disable this feature for any collection or global by setting the <code>lockDocuments</code> property to <code>false</code>. </Banner>
 
 ### Config Options
 
-The lockDocuments property exists on both the Collection Config and the Global Config. By default, document locking is enabled for all collections and globals, but you can customize the lock duration or disable the feature entirely.
+The `lockDocuments` property exists on both the Collection Config and the Global Config. Document locking is enabled by default, but you can customize the lock duration or turn off the feature for any collection or global.
 
 Here’s an example configuration for document locking:
 
@@ -55,13 +55,13 @@ export const Posts: CollectionConfig = {
 
 ### Impact on APIs
 
-Document locking affects both the Local API and the REST API, ensuring that if a document is locked, concurrent users will not be able to perform updates or deletes on that document (including globals). If a user attempts to update or delete a locked document, they will receive an error.
+Document locking affects both the Local and REST APIs, ensuring that if a document is locked, concurrent users will not be able to perform updates or deletes on that document (including globals). If a user attempts to update or delete a locked document, they will receive an error.
 
 Once the document is unlocked or the lock duration has expired, other users can proceed with updates or deletes as normal.
 
 #### Overriding Locks
 
-For operations like update and delete, Payload includes an `overrideLock` option. This boolean flag, when set to `false`, enforces document locks, ensuring that the operation will not proceed if another user currently holds the lock.
+For operations like `update` and `delete`, Payload includes an `overrideLock` option. This boolean flag, when set to `false`, enforces document locks, ensuring that the operation will not proceed if another user currently holds the lock.
 
 By default, `overrideLock` is set to `true`, which means that document locks are ignored, and the operation will proceed even if the document is locked. To enforce locks and prevent updates or deletes on locked documents, set `overrideLock: false`.
 

docs/admin/overview.mdx

@@ -195,7 +195,7 @@ app/
 
 <Banner type="warning">
   <strong>Note:</strong>
-  If you set Root-level Routes _before_ auto-generating the Admin Panel, your [Project Structure](#project-structure) will already be set up correctly.
+  If you set Root-level Routes _before_ auto-generating the Admin Panel via `create-payload-app`, your [Project Structure](#project-structure) will already be set up correctly.
 </Banner>
 
 ### Admin-level Routes

docs/admin/views.mdx

@@ -15,7 +15,7 @@ There are four types of views within the Admin Panel:
 - [Global Views](#global-views)
 - [Document Views](#document-views)
 
-To swap in your own Custom Views, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-views) accordingly.
+To swap in your own Custom View, first consult the list of available components, determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-views) accordingly.
 
 ## Root Views
 
@@ -93,7 +93,7 @@ For more granular control, pass a configuration object instead. Payload exposes
 | **`path`** \*      | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands.                                                                     |
 | **`exact`**        | Boolean. When true, will only match if the path matches the `usePathname()` exactly.                                                                                                     |
 | **`strict`**       | When true, a path that has a trailing slash will only match a `location.pathname` with a trailing slash. This has no effect when there are additional URL segments in the pathname. |
-| **`sensitive`**    | When true, will match if the path is case sensitive.
+| **`sensitive`**    | When true, will match if the path is case sensitive.|
 | **`meta`**         | Page metadata overrides to apply to this view within the Admin Panel. [More details](./metadata).                                                                           |
 
 _\* An asterisk denotes that a property is required._
@@ -133,6 +133,12 @@ The above example shows how to add a new [Root View](#root-views), but the patte
   route.
 </Banner>
 
+<Banner type="warning">
+  <strong>Custom views are public</strong>
+  <br />
+  Custom views are public by default. If your view requires a user to be logged in or to have certain access rights, you should handle that within your view component yourself.
+</Banner>
+
 ## Collection Views
 
 Collection Views are views that are scoped under the `/collections` route, such as the Collection List and Document Edit views.

docs/authentication/email.mdx

@@ -6,7 +6,7 @@ desc: Email Verification allows users to verify their email address before they'
 keywords: authentication, email, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-[Authentication](./overview) ties directly into the [Email](../email) functionality that Payload provides. This allows you to send emails to users for verification, password resets, and more. While Payload provides default email templates for these actions, you can customize them to fit your brand.
+[Authentication](./overview) ties directly into the [Email](../email/overview) functionality that Payload provides. This allows you to send emails to users for verification, password resets, and more. While Payload provides default email templates for these actions, you can customize them to fit your brand.
 
 ## Email Verification
 

docs/authentication/overview.mdx

@@ -86,7 +86,7 @@ The following options are available:
 | **`loginWithUsername`**    | Ability to allow users to login with username/password. [More](/docs/authentication/overview#login-with-username)                                                                                                                     |
 | **`maxLoginAttempts`**     | Only allow a user to attempt logging in X amount of times. Automatically locks out a user from authenticating if this limit is passed. Set to `0` to disable.                                                                       |
 | **`removeTokenFromResponses`** | Set to true if you want to remove the token from the returned authentication API responses such as login or refresh.                                                                                                                                                            |
-| **`strategies`**           | Advanced - an array of custom authentification strategies to extend this collection's authentication with. [More details](./custom-strategies).                                                                         |
+| **`strategies`**           | Advanced - an array of custom authentication strategies to extend this collection's authentication with. [More details](./custom-strategies).                                                                         |
 | **`tokenExpiration`**      | How long (in seconds) to keep the user logged in. JWTs and HTTP-only cookies will both expire at the same time.                                                                                                                     |
 | **`useAPIKey`**            | Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection. [More details](./api-keys).                                                                       |
 | **`verify`**               | Set to `true` or pass an object with verification options to require users to verify by email before they are allowed to log into your app. [More details](./email#email-verification).                                  |

docs/authentication/token-data.mdx

@@ -6,7 +6,7 @@ desc: Storing data for read on the request object.
 keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-During the lifecycle of a request you will be able to access the data you have configured to be stored in the JWT by accessing `req.user`. The user object is automatically appeneded to the request for you.
+During the lifecycle of a request you will be able to access the data you have configured to be stored in the JWT by accessing `req.user`. The user object is automatically appended to the request for you.
 
 ### Definining Token Data
 

docs/configuration/collections.mdx

@@ -58,7 +58,7 @@ export const Posts: CollectionConfig = {
 The following options are available:
 
 | Option                 | Description                                                                                                                                                                                                          |
-|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`admin`**            | The configuration options for the Admin Panel. [More details](../admin/collections).                                                                                                                                 |
 | **`access`**           | Provide Access Control functions to define exactly who should be able to do what with Documents in this Collection. [More details](../access-control/collections).                                                   |
 | **`auth`**             | Specify options if you would like this Collection to feature authentication. [More details](../authentication/overview).                                                                                             |
@@ -77,6 +77,7 @@ The following options are available:
 | **`typescript`**       | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                  |
 | **`upload`**           | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](../upload/overview) documentation.                                                                        |
 | **`versions`**         | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#collection-config).                                                                                  |
+| **`defaultPopulate`**  | Specify which fields to select when this Collection is populated from another document. [More Details](../queries/select#defaultpopulate-collection-config-property).                                                  |
 
 _\* An asterisk denotes that a property is required._
 

docs/configuration/localization.mdx

@@ -65,7 +65,7 @@ export default buildConfig({
       },
     ],
     defaultLocale: 'en', // required
-    fallback: true,
+    fallback: true, // defaults to true
   },
 })
 ```
@@ -81,7 +81,7 @@ The following options are available:
 | -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
 | **`locales`**  | Array of all the languages that you would like to support. [More details](#locales)                                            |
 | **`defaultLocale`** | Required string that matches one of the locale codes from the array provided. By default, if no locale is specified, documents will be returned in this locale. |
-| **`fallback`** | Boolean enabling "fallback" locale functionality. If a document is requested in a locale, but a field does not have a localized value corresponding to the requested locale, then if this property is enabled, the document will automatically fall back to the fallback locale value. If this property is not enabled, the value will not be populated. |
+| **`fallback`** | Boolean enabling "fallback" locale functionality. If a document is requested in a locale, but a field does not have a localized value corresponding to the requested locale, then if this property is enabled, the document will automatically fall back to the fallback locale value. If this property is not enabled, the value will not be populated unless a fallback is explicitly provided in the request. True by default. |
 
 ### Locales
 

docs/configuration/overview.mdx

@@ -8,7 +8,7 @@ keywords: overview, config, configuration, documentation, Content Management Sys
 
 Payload is a _config-based_, code-first CMS and application framework. The Payload Config is central to everything that Payload does, allowing for deep configuration of your application through a simple and intuitive API. The Payload Config is a fully-typed JavaScript object that can be infinitely extended upon.
 
-Everything from your [Database](../database/overview) choice, to the appearance of the [Admin Panel](../admin/overview), is fully controlled through the Payload Config. From here you can define [Fields](../fields/overview), add [Localization](./localization), enable [Authentication](../authentication/overview), configure [Access Control](../access-control/overview), and so much more.
+Everything from your [Database](../database/overview) choice to the appearance of the [Admin Panel](../admin/overview) is fully controlled through the Payload Config. From here you can define [Fields](../fields/overview), add [Localization](./localization), enable [Authentication](../authentication/overview), configure [Access Control](../access-control/overview), and so much more.
 
 The Payload Config is a `payload.config.ts` file typically located in the root of your project:
 
@@ -29,7 +29,7 @@ The Payload Config is strongly typed and ties directly into Payload's TypeScript
 
 ## Config Options
 
-To author your Payload Config, first determine which [Database](../database/overview) you'd like to use, then use [Collections](./collections) or [Globals](./globals) to define the schema of your data.
+To author your Payload Config, first determine which [Database](../database/overview) you'd like to use, then use [Collections](./collections) or [Globals](./globals) to define the schema of your data through [Fields](../fields/overview).
 
 Here is one of the simplest possible Payload configs:
 
@@ -76,6 +76,7 @@ The following options are available:
 | **`cors`**                 | Cross-origin resource sharing (CORS) is a mechanism that accept incoming requests from given domains. You can also customize the `Access-Control-Allow-Headers` header. [More details](#cors). |
 | **`localization`**         | Opt-in to translate your content into multiple locales. [More details](./localization).                                                                                                        |
 | **`logger`**               | Logger options, logger options with a destination stream, or an instantiated logger instance. [More details](https://getpino.io/#/docs/api?id=options).                                        |
+| **`loggingLevels`**        | An object to override the level to use in the logger for Payload's errors.                                                                                                                     |
 | **`graphQL`**              | Manage GraphQL-specific functionality, including custom queries and mutations, query complexity limits, etc. [More details](../graphql/overview#graphql-options).                              |
 | **`cookiePrefix`**         | A string that will be prefixed to all cookies that Payload sets.                                                                                                                               |
 | **`csrf`**                 | A whitelist array of URLs to allow Payload to accept cookies from. [More details](../authentication/overview#csrf-protection).                                                                 |
@@ -163,7 +164,7 @@ In development mode, if the configuration file is not found at the root, Payload
 
 **Production Mode**
 
-In production mode, Payload will first attempt to find the config file in the `outDir` of your `tsconfig.json`, and if not found, will fallback to the `rootDor` directory:
+In production mode, Payload will first attempt to find the config file in the `outDir` of your `tsconfig.json`, and if not found, will fallback to the `rootDir` directory:
 
 ```json
 {

docs/database/overview.mdx

@@ -67,6 +67,6 @@ You should prefer a relational DB like Postgres or SQLite if:
 
 ## Payload Differences
 
-It's important to note that nearly every Payload feature is available in all of our officially supported Database Adapters, including [Localization](../configuration/localization), [Arrays](../fields/array), [Blocks](../fields/blocks), etc. The only thing that is not supported in Postgres yet is the [Point Field](/docs/fields/point), but that should be added soon.
+It's important to note that nearly every Payload feature is available in all of our officially supported Database Adapters, including [Localization](../configuration/localization), [Arrays](../fields/array), [Blocks](../fields/blocks), etc. The only thing that is not supported in SQLite yet is the [Point Field](/docs/fields/point), but that should be added soon.
 
 It's up to you to choose which database you would like to use based on the requirements of your project. Payload has no opinion on which database you should ultimately choose.

docs/database/transactions.mdx

@@ -16,7 +16,7 @@ By default, Payload will use transactions for all data changing operations, as l
   MongoDB requires a connection to a replicaset in order to make use of transactions.
 </Banner>
 
-The initial request made to Payload will begin a new transaction and attach it to the `req.transactionID`. If you have a `hook` that interacts with the database, you can opt-in to using the same transaction by passing the `req` in the arguments. For example:
+The initial request made to Payload will begin a new transaction and attach it to the `req.transactionID`. If you have a `hook` that interacts with the database, you can opt in to using the same transaction by passing the `req` in the arguments. For example:
 
 ```ts
 const afterChange: CollectionAfterChangeHook = async ({ req }) => {
@@ -65,9 +65,9 @@ When writing your own scripts or custom endpoints, you may wish to have direct c
 
 The following functions can be used for managing transactions:
 
-`payload.db.beginTransaction` - Starts a new session and returns a transaction ID for use in other Payload Local API calls.
-`payload.db.commitTransaction` - Takes the identifier for the transaction, finalizes any changes.
-`payload.db.rollbackTransaction` - Takes the identifier for the transaction, discards any changes.
+- `payload.db.beginTransaction` - Starts a new session and returns a transaction ID for use in other Payload Local API calls.
+- `payload.db.commitTransaction` - Takes the identifier for the transaction, finalizes any changes.
+- `payload.db.rollbackTransaction` - Takes the identifier for the transaction, discards any changes.
 
 Payload uses the `req` object to pass the transaction ID through to the database adapter. If you are not using the `req` object, you can make a new object to pass the transaction ID directly to database adapter methods and local API calls.
 Example:
@@ -126,6 +126,6 @@ await payload.update({
   where: {
     slug: { equals: 'my-slug' }
   },
-  req: { disableTransaction: true },
+  disableTransaction: true,
 })
 ```

docs/fields/array.mdx

@@ -6,7 +6,7 @@ desc: Array Fields are intended for sets of repeating fields, that you define. L
 keywords: array, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-The Array Field is used when you need to have a set of "repeating" [Fields](./overview). It stores an array of objects containing fields that you define. These fields can be of any type, including other arrays to achieve infinitely nested structures.
+The Array Field is used when you need to have a set of "repeating" [Fields](./overview). It stores an array of objects containing fields that you define. These fields can be of any type, including other arrays, to achieve infinitely nested data structures.
 
 Arrays are useful for many different types of content from simple to complex, such as:
 

docs/fields/date.mdx

@@ -86,7 +86,7 @@ _\* This property is passed directly to [react-datepicker](https://github.com/Ha
 
 These properties only affect how the date is displayed in the UI. The full date is always stored in the format `YYYY-MM-DDTHH:mm:ss.SSSZ` (e.g. `1999-01-01T8:00:00.000+05:00`).
 
-`displayFormat` determines how the date is presented in the field **cell**, you can pass any valid (unicode date format)[https://date-fns.org/v2.29.3/docs/format].
+`displayFormat` determines how the date is presented in the field **cell**, you can pass any valid (unicode date format)[https://date-fns.org/v4.1.0/docs/format].
 
 `pickerAppearance` sets the appearance of the **react datepicker**, the options available are `dayAndTime`, `dayOnly`, `timeOnly`, and `monthOnly`. By default, the datepicker will display `dayOnly`.
 

docs/fields/join.mdx

@@ -121,23 +121,34 @@ powerful Admin UI.
 
 ## Config Options
 
-| Option                 | Description                                                                                                                                                                                   |
-|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*          | To be used as the property name when retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                   |
-| **`collection`** \*    | The `slug`s having the relationship field.                                                                                                                                                    |
-| **`on`** \*            | The name of the relationship or upload field that relates to the collection document. Use dot notation for nested paths, like 'myGroup.relationName'.                                         |
-| **`maxDepth`**         | Default is 1, Sets a maximum population depth for this field, regardless of the remaining depth when this field is reached. [Max Depth](/docs/getting-started/concepts#field-level-max-depth) |
-| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                                       |
-| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                         |
-| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                            |
-| **`defaultLimit`**     | The number of documents to return. Set to 0 to return all related documents.                                                                                                                  |
-| **`defaultSort`**      | The field name used to specify the order the joined documents are returned.                                                                                                                   |
-| **`admin`**            | Admin-specific configuration.                                                                                                                                                                 |
-| **`custom`**           | Extension point for adding custom data (e.g. for plugins).                                                                                                                                    |
-| **`typescriptSchema`** | Override field type generation with providing a JSON schema.                                                                                                                                  |
+| Option                 | Description                                                                                                                                                                                    |
+|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`name`** \*          | To be used as the property name when retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                    |
+| **`collection`** \*    | The `slug`s having the relationship field.                                                                                                                                                     |
+| **`on`** \*            | The name of the relationship or upload field that relates to the collection document. Use dot notation for nested paths, like 'myGroup.relationName'.                                          |
+| **`where`** \*         | A `Where` query to hide related documents from appearing. Will be merged with any `where` specified in the request.                                                                            |
+| **`maxDepth`**         | Default is 1, Sets a maximum population depth for this field, regardless of the remaining depth when this field is reached. [Max Depth](/docs/getting-started/concepts#field-level-max-depth). |
+| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                                        |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                          |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                             |
+| **`defaultLimit`**     | The number of documents to return. Set to 0 to return all related documents.                                                                                                                   |
+| **`defaultSort`**      | The field name used to specify the order the joined documents are returned.                                                                                                                    |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-config-options).                                                                                                                           |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins).                                                                                                                                     |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema.                                                                                                                                   |
 
 _\* An asterisk denotes that a property is required._
 
+
+## Admin Config Options
+
+You can control the user experience of the join field using the `admin` config properties. The following options are supported:
+
+| Option                 | Description                                                                            |
+|------------------------|----------------------------------------------------------------------------------------|
+| **`allowCreate`**      | Set to `false` to remove the controls for making new related documents from this field. |
+| **`components.Label`** | Override the default Label of the Field Component. [More details](../admin/fields#label) |
+
 ## Join Field Data
 
 When a document is returned that for a Join field is populated with related documents. The structure returned is an
@@ -172,11 +183,11 @@ returning. This is useful for performance reasons when you don't need the relate
 
 The following query options are supported:
 
-| Property    | Description                                                  |
-|-------------|--------------------------------------------------------------|
-| **`limit`** | The maximum related documents to be returned, default is 10. |
-| **`where`** | An optional `Where` query to filter joined documents.        |
-| **`sort`**  | A string used to order related results                       |
+| Property    | Description                                                                                         |
+|-------------|-----------------------------------------------------------------------------------------------------|
+| **`limit`** | The maximum related documents to be returned, default is 10.                                        |
+| **`where`** | An optional `Where` query to filter joined documents. Will be merged with the field `where` object. |
+| **`sort`**  | A string used to order related results                                                              |
 
 These can be applied to the local API, GraphQL, and REST API.
 

docs/fields/json.mdx

@@ -7,7 +7,7 @@ desc: The JSON field type will store any string in the Database. Learn how to us
 keywords: json, jsonSchema, schema, validation, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-The JSON Field saves actual JSON in the database, which differs from the Code field that saves the value as a string in the database.
+The JSON Field saves raw JSON to the database and provides the [Admin Panel](../admin/overview) with a code editor styled interface. This is different from the [Code Field](./code) which saves the value as a string in the database.
 
 <LightDarkImage
   srcLight="https://payloadcms.com/images/docs/fields/json.png"

docs/fields/overview.mdx

@@ -93,13 +93,14 @@ Presentational Fields do not store data in the database. Instead, they are used
 Here are the available Presentational Fields:
 
 - [Collapsible](/docs/fields/collapsible) - nests fields within a collapsible component
+- [Join](/docs/fields/join) - achieves two-way data binding between fields
 - [Row](/docs/fields/row) - aligns fields horizontally
 - [Tabs (Unnamed)](/docs/fields/tabs) - nests fields within a tabbed layout
 - [UI](/docs/fields/ui) - blank field for custom UI components
 
 <Banner type="warning">
   <strong>Tip:</strong>
-  Don't see a Field Type that fits your needs? You can build your own using a [Custom Field Component](../admin/fields#the-field-component).
+  Don't see a Field Type that fits your needs? You can build your own using a [Custom Field Component](../admin/fields#field).
 </Banner>
 
 ## Field Options
@@ -123,7 +124,7 @@ export const MyField: Field = {
 
 ### Field Names
 
-All [Data Fields](#data-fields) require a `name` property. This is the key that will be used to store and retrieve the field's value in the database. This property must be unique within the Collection, Global, or nested group that it is defined in.
+All [Data Fields](#data-fields) require a `name` property. This is the key that will be used to store and retrieve the field's value in the database. This property must be unique amongst this field's siblings.
 
 To set a field's name, use the `name` property in your Field Config:
 
@@ -205,7 +206,7 @@ export const MyField: Field = {
 }
 ```
 
-Default values can be defined as a static value or a function that returns a value. When a `defaultValue` is defined statically, Payload's DB adapters will apply it to the database schema or models.
+Default values can be defined as a static value or a function that returns a value. When a `defaultValue` is defined statically, Payload's [Database Adapters](../database/overview) will apply it to the database schema or models.
 
 Functions can be written to make use of the following argument properties:
 
@@ -264,7 +265,7 @@ The following arguments are provided to the `validate` function:
 
 #### Validation Context
 
-The `ctx` argument contains full document data, sibling field data, the current operation, and other useful information such as currently authenticated in user:
+The `ctx` argument contains full document data, sibling field data, the current operation, and other useful information such as currently authenticated user:
 
 ```ts
 import type { Field } from 'payload'
@@ -356,9 +357,9 @@ For full details on Admin Options, see the [Field Admin Options](../admin/fields
 
 ## Custom ID Fields
 
-All [Collections](../configuration/collections) automatically generate their own ID field. If needed, you can override this behavior by providing an explicit ID field to your config. This will force users to provide a their own ID value when creating a record.
+All [Collections](../configuration/collections) automatically generate their own ID field. If needed, you can override this behavior by providing an explicit ID field to your config. This field should either be required or have a hook to generate the ID dynamically.
 
-To define a custom ID field, add a new field with the `name` property set to `id`:
+To define a custom ID field, add a top-level field with the `name` property set to `id`:
 
 ```ts
 import type { CollectionConfig } from 'payload'
@@ -368,6 +369,7 @@ export const MyCollection: CollectionConfig = {
   fields: [
     {
       name: 'id', // highlight-line
+      required: true,
       type: 'number',
     },
   ],

docs/fields/point.mdx

@@ -28,7 +28,7 @@ export const MyPointField: Field = {
 
 <Banner type="warning">
   <strong>Important:</strong>
-  The Point Field is currently only supported in MongoDB.
+  The Point Field currently is not supported in SQLite.
 </Banner>
 
 ## Config
@@ -73,6 +73,59 @@ export const ExampleCollection: CollectionConfig = {
 }
 ```
 
-## Querying
+## Querying - near
 
 In order to do query based on the distance to another point, you can use the `near` operator. When querying using the near operator, the returned documents will be sorted by nearest first.
+
+## Querying - within
+
+In order to do query based on whether points are within a specific area defined in GeoJSON, you can use the `within` operator.
+Example:
+```ts
+const polygon: Point[] = [
+  [9.0, 19.0], // bottom-left
+  [9.0, 21.0], // top-left
+  [11.0, 21.0], // top-right
+  [11.0, 19.0], // bottom-right
+  [9.0, 19.0], // back to starting point to close the polygon
+]
+
+payload.find({
+  collection: "points",
+  where: {
+    point: {
+      within: {
+        type: 'Polygon',
+        coordinates: [polygon],
+      },
+    },
+  },
+})
+```
+
+
+## Querying - intersects
+
+In order to do query based on whether points intersect a specific area defined in GeoJSON, you can use the `intersects` operator.
+Example:
+```ts
+const polygon: Point[] = [
+  [9.0, 19.0], // bottom-left
+  [9.0, 21.0], // top-left
+  [11.0, 21.0], // top-right
+  [11.0, 19.0], // bottom-right
+  [9.0, 19.0], // back to starting point to close the polygon
+]
+
+payload.find({
+  collection: "points",
+  where: {
+    point: {
+      intersects: {
+        type: 'Polygon',
+        coordinates: [polygon],
+      },
+    },
+  },
+})
+```

docs/fields/radio.mdx

@@ -83,7 +83,7 @@ The Radio Field inherits all of the default options from the base [Field Admin C
 
 | Property                       | Description                                                                                                                            |
 | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
-| **`layout`**                   | Allows for the radio group to be styled as a horizonally or vertically distributed list. The default value is `horizontal`.          |
+| **`layout`**                   | Allows for the radio group to be styled as a horizontally or vertically distributed list. The default value is `horizontal`.          |
 
 ## Example
 

docs/fields/rich-text.mdx

@@ -25,11 +25,7 @@ Right now, Payload is officially supporting two rich text editors:
 <Banner type="success">
   <strong>
     Consistent with Payload's goal of making you learn as little of Payload as possible, customizing
-    and using the Rich Text Editor does not involve learning how to develop for a
-    {' '}
-    <em>Payload</em>
-    {' '}
-    rich text editor.
+    and using the Rich Text Editor does not involve learning how to develop for a{' '}<em>Payload</em>{' '}rich text editor.
   </strong>
 
   Instead, you can invest your time and effort into learning the underlying open-source tools that

docs/fields/select.mdx

@@ -204,4 +204,4 @@ If you are looking to create a dynamic select field, the following tutorial will
   drawerTitle="How to Create a Custom Select Field: A Step-by-Step Guide"
 />
 
-If you want to learn more about custom components check out the [Admin > Custom Component](/docs/admin/components#field-component) docs.
+If you want to learn more about custom components check out the [Admin > Custom Component](/docs/admin/components#field) docs.

docs/fields/ui.mdx

@@ -32,8 +32,8 @@ export const MyUIField: Field = {
 | ------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
 | **`name`** \*                   | A unique identifier for this field.                                                                                 |
 | **`label`**                     | Human-readable label for this UI field.                                                                             |
-| **`admin.components.Field`** \* | React component to be rendered for this field within the Edit View. [More](../admin/components/#field-component)    |
-| **`admin.components.Cell`**     | React component to be rendered as a Cell within collection List views. [More](../admin/components/#field-component) |
+| **`admin.components.Field`** \* | React component to be rendered for this field within the Edit View. [More](../admin/components/#field)    |
+| **`admin.components.Cell`**     | React component to be rendered as a Cell within collection List views. [More](../admin/components/#field) |
 | **`admin.disableListColumn`**   | Set `disableListColumn` to `true` to prevent the UI field from appearing in the list view column selector.          |
 | **`custom`**                    | Extension point for adding custom data (e.g. for plugins)                                                           |
 

docs/fields/upload.mdx

@@ -46,8 +46,11 @@ export const MyUploadField: Field = {
 | Option                 | Description                                                                                                                                                                 |
 |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`*relationTo`** \*   | Provide a single collection `slug` to allow this field to accept a relation to. <strong>Note: the related collection must be configured to support Uploads.</strong>        |
+| **`relationTo`** \*    | Provide a single collection `slug` to allow this field to accept a relation to. <strong>Note: the related collection must be configured to support Uploads.</strong>        |
 | **`filterOptions`**    | A query to filter which options appear in the UI and validate against. [More](#filtering-upload-options).                                                                   |
+| **`hasMany`**          | Boolean which, if set to true, allows this field to have many relations instead of only one.                                                                                |
+| **`minRows`**          | A number for the fewest allowed items during validation when a value is present. Used with hasMany.                                                                         |
+| **`maxRows`**          | A number for the most allowed items during validation when a value is present. Used with hasMany.                                                                           |
 | **`maxDepth`**         | Sets a number limit on iterations of related documents to populate when queried. [Depth](../queries/depth)                                                                  |
 | **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                     |
 | **`unique`**           | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |

docs/getting-started/installation.mdx

@@ -35,6 +35,10 @@ Adding Payload to an existing Next.js app is super straightforward. You can eith
 
 If you don't have a Next.js app already, but you still want to start a project from a blank Next.js app, you can create a new Next.js app using `npx create-next-app` - and then just follow the steps below to install Payload.
 
+<Banner type="info">
+  <strong>Note:</strong> Next.js version 15 or higher is required for Payload.
+</Banner>
+
 #### 1. Install the relevant packages
 
 First, you'll want to add the required Payload packages to your project and can do so by running the command below:

docs/hooks/context.mdx

@@ -139,4 +139,4 @@ declare module 'payload' {
 }
 ```
 
-This will add a the property `myObject` with a type of string to every context object. Make sure to follow this example correctly, as type augmentation can mess up your types if you do it wrong.
+This will add the property `myObject` with a type of string to every context object. Make sure to follow this example correctly, as type augmentation can mess up your types if you do it wrong.

docs/jobs-queue/jobs.mdx

@@ -0,0 +1,46 @@
+---
+title: Jobs
+label: Jobs
+order: 40
+desc: A Job is a set of work that is offloaded from your APIs and will be processed at a later date.
+keywords: jobs queue, application framework, typescript, node, react, nextjs
+---
+
+Now that we have covered Tasks and Workflows, we can tie them together with a concept called a Job.
+
+<Banner type="default">
+  Whereas you define Workflows and Tasks, which control your business logic, a <strong>Job</strong> is an individual instance of either a Task or a Workflow which contains many tasks.
+</Banner>
+
+For example, let's say we have a Workflow or Task that describes the logic to sync information from Payload to a third-party system. This is how you'd declare how to sync that info, but it wouldn't do anything on its own. In order to run that task or workflow, you'd create a Job that references the corresponding Task or Workflow.
+
+Jobs are stored in the Payload database in the `payload-jobs` collection, and you can decide to keep a running list of all jobs, or configure Payload to delete the job when it has been successfully executed.
+
+#### Queuing a new job
+
+In order to queue a job, you can use the `payload.jobs.queue` function.
+
+Here's how you'd queue a new Job, which will run a `createPostAndUpdate` workflow:
+
+```ts
+const createdJob = await payload.jobs.queue({
+  // Pass the name of the workflow
+  workflow: 'createPostAndUpdate',
+  // The input type will be automatically typed
+  // according to the input you've defined for this workflow
+  input: {
+    title: 'my title',
+  },
+})
+```
+
+In addition to being able to queue new Jobs based on Workflows, you can also queue a job for a single Task:
+
+```ts
+const createdJob = await payload.jobs.queue({
+  task: 'createPost',
+  input: {
+    title: 'my title',
+  },
+})
+```

docs/jobs-queue/overview.mdx

@@ -0,0 +1,70 @@
+---
+title: Jobs Queue
+label: Overview
+order: 10
+desc: Payload provides all you need to run job queues, which are helpful to offload long-running processes into separate workers.
+keywords: jobs queue, application framework, typescript, node, react, nextjs
+---
+
+Payload's Jobs Queue gives you a simple, yet powerful way to offload large or future tasks to separate compute resources which is a very powerful feature of many application frameworks.
+
+### Example use cases
+
+**Non-blocking workloads**
+
+You might need to perform some complex, slow-running logic in a Payload [Hook](/docs/hooks/overview) but you don't want that hook to "block" or slow down the response returned from the Payload API. Instead of running this logic directly in a hook, which would block your API response from returning until the expensive work is completed, you can queue a new Job and let it run at a later date.
+
+Examples:
+
+- Create vector embeddings from your documents, and keep them in sync as your documents change
+- Send data to a third-party API on document change
+- Trigger emails based on customer actions
+
+**Scheduled actions**
+
+If you need to schedule an action to be run or processed at a certain date in the future, you can queue a job with the `waitUntil` property set. This will make it so the job is not "picked up" until that `waitUntil` date has passed.
+
+Examples:
+
+- Process scheduled posts, where the scheduled date is at a time set in the future
+- Unpublish posts at a given time
+- Send a reminder email to a customer after X days of signing up for a trial
+
+**Periodic sync or similar scheduled action**
+
+Some applications may need to perform a regularly scheduled operation of some type. Jobs are perfect for this because you can execute their logic using `cron`, scheduled nightly, every twelve hours, or some similar time period. 
+
+Examples:
+
+- You'd like to send emails to all customers on a regular, scheduled basis
+- Periodically trigger a rebuild of your frontend at night
+- Sync resources to or from a third-party API during non-peak times
+
+**Offloading complex operations**
+
+You may run into the need to perform computationally expensive functions which might slow down your main Payload API server(s). The Jobs Queue allows you to offload these tasks a separate compute resource rather than slowing down the server(s) that run your Payload APIs. With Payload Task definitions, you can even keep large dependencies out of your main Next.js bundle by dynamically importing them only when they are used. This keeps your Next.js + Payload compilation fast and ensures large dependencies do not get bundled into your Payload production build.
+
+Examples:
+
+- You need to create (and then keep in sync) vector embeddings of your documents as they change, but you use an open source model to generate embeddings
+- You have a PDF generator that needs to dynamically build and send PDF versions of documents to customers
+- You need to use a headless browser to perform some type of logic
+- You need to perform a series of actions, each of which depends on a prior action and should be run in as "durable" of a fashion as possible 
+
+### How it works
+
+There are a few concepts that you should become familiarized with before using Payload's Jobs Queue. We recommend learning what each of these does in order to fully understand how to leverage the power of Payload's Jobs Queue.
+
+1. [Tasks](/docs/beta/jobs-queue/tasks)
+1. [Workflows](/docs/beta/jobs-queue/workflows)
+1. [Jobs](/docs/beta/jobs-queue/jobs)
+1. [Queues](/docs/beta/jobs-queue/queues)
+
+All of these pieces work together in order to allow you to offload long-running, expensive, or future scheduled work from your main APIs. 
+
+Here's a quick overview:
+
+- A Task is a specific function that performs business logic
+- Workflows are groupings of specific tasks which should be run in-order, and can be retried from a specific point of failure
+- A Job is an instance of a single task or workflow which will be executed
+- A Queue is a way to segment your jobs into different "groups" - for example, some to run nightly, and others to run every 10 minutes 

docs/jobs-queue/queues.mdx

@@ -0,0 +1,120 @@
+---
+title: Queues
+label: Queues
+order: 50
+desc: A Queue is a specific group of jobs which can be executed in the order that they were added.
+keywords: jobs queue, application framework, typescript, node, react, nextjs
+---
+
+Queues are the final aspect of Payload's Jobs Queue and deal with how to _run your jobs_. Up to this point, all we've covered is how to queue up jobs to run, but so far, we aren't actually running any jobs.
+
+<Banner type="default">
+  A <strong>Queue</strong> is a grouping of jobs that should be executed in order of when they were added.
+</Banner>
+
+When you go to run jobs, Payload will query for any jobs that are added to the queue and then run them. By default, all queued jobs are added to the `default` queue.
+
+**But, imagine if you wanted to have some jobs that run nightly, and other jobs which should run every five minutes.**
+
+By specifying the `queue` name when you queue a new job using `payload.jobs.queue()`, you can queue certain jobs with `queue: 'nightly'`, and other jobs can be left as the default queue.
+
+Then, you could configure two different runner strategies:
+
+1. A `cron` that runs nightly, querying for jobs added to the `nightly` queue
+2. Another that runs any jobs that were added to the `default` queue every ~5 minutes or so
+
+## Executing jobs
+
+As mentioned above, you can queue jobs, but the jobs won't run unless a worker picks up your jobs and runs them. This can be done in two ways:
+
+#### Endpoint
+
+You can execute jobs by making a fetch request to the `/api/payload-jobs/run` endpoint:
+
+```ts
+// Here, we're saying we want to run only 100 jobs for this invocation
+// and we want to pull jobs from the `nightly` queue:
+await fetch('/api/payload-jobs/run?limit=100&queue=nightly', {
+  method: 'GET',
+  headers: {
+    'Authorization': `Bearer ${token}`,
+  },
+});
+```
+
+This endpoint is automatically mounted for you and is helpful in conjunction with serverless platforms like Vercel, where you might want to use Vercel Cron to invoke a serverless function that executes your jobs.
+
+**Vercel Cron Example**
+
+If you're deploying on Vercel, you can add a `vercel.json` file in the root of your project that configures Vercel Cron to invoke the `run` endpoint on a cron schedule.
+
+Here's an example of what this file will look like:
+
+```json
+{
+  "crons": [
+    {
+      "path": "/api/payload-jobs/run",
+      "schedule": "*/5 * * * *"
+    }
+  ]
+}
+```
+
+The configuration above schedules the endpoint `/api/payload-jobs/run` to be invoked every 5 minutes.
+
+The last step will be to secure your `run` endpoint so that only the proper users can invoke the runner.
+
+To do this, you can set an environment variable on your Vercel project called `CRON_SECRET`, which should be a random string—ideally 16 characters or longer.
+
+Then, you can modify the `access` function for running jobs by ensuring that only Vercel can invoke your runner.
+
+```ts
+export default buildConfig({
+  // Other configurations...
+  jobs: {
+    access: {
+      run: ({ req }: { req: PayloadRequest }): boolean => {
+        // Allow logged in users to execute this endpoint (default)
+        if (req.user) return true
+
+        // If there is no logged in user, then check
+        // for the Vercel Cron secret to be present as an
+        // Authorization header:
+        const authHeader = req.headers.get('authorization');
+        return authHeader === `Bearer ${process.env.CRON_SECRET}`;
+      },
+    },
+    // Other job configurations...
+  }
+})
+```
+
+This works because Vercel automatically makes the `CRON_SECRET` environment variable available to the endpoint as the `Authorization` header when triggered by the Vercel Cron, ensuring that the jobs can be run securely.
+
+After the project is deployed to Vercel, the Vercel Cron job will automatically trigger the `/api/payload-jobs/run` endpoint in the specified schedule, running the queued jobs in the background.
+
+#### Local API
+
+If you want to process jobs programmatically from your server-side code, you can use the Local API:
+
+```ts
+const results = await payload.jobs.run()
+
+// You can customize the queue name and limit by passing them as arguments:
+await payload.jobs.run({ queue: 'nightly', limit: 100 })
+```
+
+#### Bin script
+
+Finally, you can process jobs via the bin script that comes with Payload out of the box.
+
+```sh
+npx payload jobs:run --queue default --limit 10
+```
+
+In addition, the bin script allows you to pass a `--cron` flag to the `jobs:run` command to run the jobs on a scheduled, cron basis:
+
+```sh
+npx payload jobs:run --cron "*/5 * * * *"
+```

docs/jobs-queue/tasks.mdx

@@ -0,0 +1,141 @@
+---
+title: Tasks
+label: Tasks
+order: 20
+desc: A Task is a distinct function declaration that can be run within Payload's Jobs Queue. 
+keywords: jobs queue, application framework, typescript, node, react, nextjs
+---
+
+<Banner type="default">
+  A <strong>"Task"</strong> is a function definition that performs business logic and whose input and output are both strongly typed.
+</Banner>
+
+You can register Tasks on the Payload config, and then create [Jobs](/docs/beta/jobs-queue/jobs) or [Workflows](/docs/beta/jobs-queue/workflows) that use them. Think of Tasks like tidy, isolated "functions that do one specific thing".
+
+Payload Tasks can be configured to automatically retried if they fail, which makes them valuable for "durable" workflows like AI applications where LLMs can return non-deterministic results, and might need to be retried.
+
+Tasks can either be defined within the `jobs.tasks` array in your payload config, or they can be defined inline within a workflow.
+
+### Defining tasks in the config
+
+Simply add a task to the `jobs.tasks` array in your Payload config. A task consists of the following fields:
+
+| Option                      | Description                                                                      |
+| --------------------------- | -------------------------------------------------------------------------------- |
+| `slug` | Define a slug-based name for this job. This slug needs to be unique among both tasks and workflows.|
+| `handler`   | The function that should be responsible for running the job. You can either pass a string-based path to the job function file, or the job function itself. If you are using large dependencies within your job, you might prefer to pass the string path because that will avoid bundling large dependencies in your Next.js app.         |
+| `inputSchema` | Define the input field schema - payload will generate a type for this schema. |
+| `interfaceName` | You can use interfaceName to change the name of the interface that is generated for this task. By default, this is "Task" + the capitalized task slug. |
+| `outputSchema` | Define the output field schema - payload will generate a type for this schema. |
+| `label` | Define a human-friendly label for this task. |
+| `onFail` | Function to be executed if the task fails. |
+| `onSuccess` | Function to be executed if the task succeeds. |
+| `retries` | Specify the number of times that this step should be retried if it fails. |
+
+The logic for the Task is defined in the `handler` - which can be defined as a function, or a path to a function. The `handler` will run once a worker picks picks up a Job that includes this task.
+
+It should return an object with an `output` key, which should contain the output of the task as you've defined.
+
+Example:
+
+```ts
+export default buildConfig({
+  // ...
+  jobs: {
+    tasks: [
+      {
+        // Configure this task to automatically retry
+        // up to two times
+        retries: 2,
+
+        // This is a unique identifier for the task
+
+        slug: 'createPost',
+
+        // These are the arguments that your Task will accept
+        inputSchema: [
+          {
+            name: 'title',
+            type: 'text',
+            required: true,
+          },
+        ],
+
+        // These are the properties that the function should output
+        outputSchema: [
+          {
+            name: 'postID',
+            type: 'text',
+            required: true,
+          },
+        ],
+
+        // This is the function that is run when the task is invoked
+        handler: async ({ input, job, req }) => {
+          const newPost = await req.payload.create({
+            collection: 'post',
+            req,
+            data: {
+              title: input.title,
+            },
+          })
+          return {
+            output: {
+              postID: newPost.id,
+            },
+          }
+        },
+      } as TaskConfig<'createPost'>,
+    ]
+  }
+})
+```
+
+In addition to defining handlers as functions directly provided to your Payload config, you can also pass an _absolute path_ to where the handler is defined. If your task has large dependencies, and you are planning on executing your jobs in a separate process that has access to the filesystem, this could be a handy way to make sure that your Payload + Next.js app remains quick to compile and has minimal dependencies.
+
+In general, this is an advanced use case. Here's how this would look:
+
+`payload.config.ts:`
+
+```ts
+import { fileURLToPath } from 'node:url'
+import path from 'path'
+
+const filename = fileURLToPath(import.meta.url)
+const dirname = path.dirname(filename)
+
+export default buildConfig({
+  jobs: {
+    tasks: [
+      {
+        // ...
+        // The #createPostHandler is a named export within the `createPost.ts` file
+        handler: path.resolve(dirname, 'src/tasks/createPost.ts') + '#createPostHandler',
+      }
+    ]
+  }
+})
+```
+
+Then, the `createPost` file itself:
+
+`src/tasks/createPost.ts:`
+
+```ts
+import type { TaskHandler } from 'payload'
+
+export const createPostHandler: TaskHandler<'createPost'> = async ({ input, job, req }) => {
+  const newPost = await req.payload.create({
+    collection: 'post',
+    req,
+    data: {
+      title: input.title,
+    },
+  })
+  return {
+    output: {
+      postID: newPost.id,
+    },
+  }
+}
+```

docs/jobs-queue/workflows.mdx

@@ -0,0 +1,150 @@
+---
+title: Workflows
+label: Workflows
+order: 30
+desc: A Task is a distinct function declaration that can be run within Payload's Jobs Queue. 
+keywords: jobs queue, application framework, typescript, node, react, nextjs
+---
+
+<Banner type="default">
+  A <strong>"Workflow"</strong> is an optional way to <em>combine multiple tasks together</em> in a way that can be gracefully retried from the point of failure.
+</Banner>
+
+They're most helpful when you have multiple tasks in a row, and you want to configure each task to be able to be retried if they fail.
+
+If a task within a workflow fails, the Workflow will automatically "pick back up" on the task where it failed and **not re-execute any prior tasks that have already been executed**.
+
+#### Defining a workflow
+
+The most important aspect of a Workflow is the `handler`, where you can declare when and how the tasks should run by simply calling the `runTask` function. If any task within the workflow, fails, the entire `handler` function will re-run.
+
+However, importantly, tasks that have successfully been completed will simply re-return the cached and saved output without running again. The Workflow will pick back up where it failed and only task from the failure point onward will be re-executed.
+
+To define a JS-based workflow, simply add a workflow to the `jobs.wokflows` array in your Payload config. A workflow consists of the following fields:
+
+| Option                      | Description                                                                      |
+| --------------------------- | -------------------------------------------------------------------------------- |
+| `slug` | Define a slug-based name for this workflow. This slug needs to be unique among both tasks and workflows.|
+| `handler`   | The function that should be responsible for running the workflow. You can either pass a string-based path to the workflow function file, or workflow job function itself. If you are using large dependencies within your workflow, you might prefer to pass the string path because that will avoid bundling large dependencies in your Next.js app.         |
+| `inputSchema` | Define the input field schema - payload will generate a type for this schema. |
+| `interfaceName` | You can use interfaceName to change the name of the interface that is generated for this workflow. By default, this is "Workflow" + the capitalized workflow slug. |
+| `label` | Define a human-friendly label for this workflow. |
+| `queue` | Optionally, define the queue name that this workflow should be tied to. Defaults to "default". |
+
+Example:
+
+```ts
+export default buildConfig({
+  // ...
+  jobs: {
+    tasks: [
+      // ...
+    ]
+    workflows: [
+      {
+        slug: 'createPostAndUpdate',
+
+        // The arguments that the workflow will accept
+        inputSchema: [
+          {
+            name: 'title',
+            type: 'text',
+            required: true,
+          },
+        ],
+
+        // The handler that defines the "control flow" of the workflow
+        // Notice how it uses the `tasks` argument to execute your predefined tasks.
+        // These are strongly typed!
+        handler: async ({ job, tasks }) => {
+
+          // This workflow first runs a task called `createPost`.
+
+          // You need to define a unique ID for this task invocation
+          // that will always be the same if this workflow fails
+          // and is re-executed in the future. Here, we hard-code it to '1'
+          const output = await tasks.createPost('1', {
+            input: {
+              title: job.input.title,
+            },
+          })
+
+          // Once the prior task completes, it will run a task
+          // called `updatePost`
+          await tasks.updatePost('2', {
+            input: {
+              post: job.taskStatus.createPost['1'].output.postID, // or output.postID
+              title: job.input.title + '2',
+            },
+          })
+        },
+      } as WorkflowConfig<'updatePost'>
+    ]
+  }
+})
+```
+
+#### Running tasks inline
+
+In the above example, our workflow was executing tasks that we already had defined in our Payload config. But, you can also run tasks without predefining them.
+
+To do this, you can use the `inlineTask` function.
+
+The drawbacks of this approach are that tasks cannot be re-used across workflows as easily, and the **task data stored in the job** will not be typed. In the following example, the inline task data will be stored on the job under `job.taskStatus.inline['2']` but completely untyped, as types for dynamic tasks like these cannot be generated beforehand.
+
+Example:
+
+```ts
+export default buildConfig({
+  // ...
+  jobs: {
+    tasks: [
+      // ...
+    ]
+    workflows: [
+      {
+        slug: 'createPostAndUpdate',
+        inputSchema: [
+          {
+            name: 'title',
+            type: 'text',
+            required: true,
+          },
+        ],
+        handler: async ({ job, tasks, inlineTask }) => {
+          // Here, we run a predefined task.
+          // The `createPost` handler arguments and return type
+          // are both strongly typed
+          const output = await tasks.createPost('1', {
+            input: {
+              title: job.input.title,
+            },
+          })
+
+          // Here, this task is not defined in the Payload config
+          // and is "inline". Its output will be stored on the Job in the database
+          // however its arguments will be untyped.
+          const { newPost } = await inlineTask('2', {
+            task: async ({ req }) => {
+              const newPost = await req.payload.update({
+                collection: 'post',
+                id: '2',
+                req,
+                retries: 3,
+                data: {
+                  title: 'updated!',
+                },
+              })
+              return {
+                output: {
+                  newPost
+                },
+              }
+            },
+          })
+        },
+      } as WorkflowConfig<'updatePost'>
+    ]
+  }
+})
+```

docs/lexical/converters.mdx

@@ -370,7 +370,12 @@ const yourEditorState: SerializedEditorState // <= your current editor state her
 
 // Import editor state into your headless editor
 try {
-  headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState)) // This should commit the editor state immediately
+  headlessEditor.update(
+    () => {
+      headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState))
+    },
+    { discrete: true },  // This should commit the editor state immediately
+  )
 } catch (e) {
   logger.error({ err: e }, 'ERROR parsing editor state')
 }
@@ -382,8 +387,6 @@ headlessEditor.getEditorState().read(() => {
 })
 ```
 
-The `.setEditorState()` function immediately updates your editor state. Thus, there's no need for the `discrete: true` flag when reading the state afterward.
-
 ## Lexical => Plain Text
 
 Export content from the Lexical editor into plain text using these steps:
@@ -401,8 +404,13 @@ const yourEditorState: SerializedEditorState // <= your current editor state her
 
 // Import editor state into your headless editor
 try {
-  headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState)) // This should commit the editor state immediately
-} catch (e) {
+    headlessEditor.update(
+    () => {
+      headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState))
+    },
+    { discrete: true },  // This should commit the editor state immediately
+  )
+  } catch (e) {
   logger.error({ err: e }, 'ERROR parsing editor state')
 }
 

docs/lexical/migration.mdx

@@ -52,7 +52,7 @@ const Pages: CollectionConfig = {
 }
 ```
 
-and done! Now, everytime this lexical editor is initialized, it converts the slate date to lexical on-the-fly. If the data is already in lexical format, it will just pass it through.
+and done! Now, every time this lexical editor is initialized, it converts the slate date to lexical on-the-fly. If the data is already in lexical format, it will just pass it through.
 
 This is by far the easiest way to migrate from Slate to Lexical, although it does come with a few caveats:
 

docs/local-api/overview.mdx

@@ -77,24 +77,37 @@ Both options function in exactly the same way outside of one having HMR support
 
 You can specify more options within the Local API vs. REST or GraphQL due to the server-only context that they are executed in.
 
-| Local Option          | Description                                                                                                                                                                                                                                                                                                                                                           |
-|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `collection`          | Required for Collection operations. Specifies the Collection slug to operate against.                                                                                                                                                                                                                                                                                 |
-| `data`                | The data to use within the operation. Required for `create`, `update`.                                                                                                                                                                                                                                                                                                |
-| `depth`               | [Control auto-population](../queries/depth) of nested relationship and upload fields.                                                                                                                                                                                                                                                                                 |
-| `locale`              | Specify [locale](/docs/configuration/localization) for any returned documents.                                                                                                                                                                                                                                                                                        |
-| `fallbackLocale`      | Specify a [fallback locale](/docs/configuration/localization) to use for any returned documents.                                                                                                                                                                                                                                                                      |
-| `overrideAccess`      | Skip access control. By default, this property is set to true within all Local API operations.                                                                                                                                                                                                                                                                        |
-| `overrideLock`        | By default, document locks are ignored (`true`). Set to `false` to enforce locks and prevent operations when a document is locked by another user. [More details](../admin/locked-documents).                                                                                                                                                                         |
-| `user`                | If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.                                                                                                                                                                                                                                                                 |
-| `showHiddenFields`    | Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.                                                                                                                                                                                                                                                  |
-| `pagination`          | Set to false to return all documents and avoid querying for document counts.                                                                                                                                                                                                                                                                                          |
-| `context`             | [Context](/docs/hooks/context), which will then be passed to `context` and `req.context`, which can be read by hooks. Useful if you want to pass additional information to the hooks which shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook to determine if it should run or not. |
-| `disableErrors`       | When set to `true`, errors will not be thrown. Instead, the `findByID` operation will return `null`, and the `find` operation will return an empty documents array.                                                                                                                                                                                                   |
-| `disableTransaction`  | When set to `true`, a [database transactions](../database/transactions) will not be initialized.                                                                                                                                                                                                                                                                      |
+| Local Option         | Description                                                                                                                                                                                                                                                                                                                                                           |
+| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `collection`         | Required for Collection operations. Specifies the Collection slug to operate against.                                                                                                                                                                                                                                                                                 |
+| `data`               | The data to use within the operation. Required for `create`, `update`.                                                                                                                                                                                                                                                                                                |
+| `depth`              | [Control auto-population](../queries/depth) of nested relationship and upload fields.                                                                                                                                                                                                                                                                                 |
+| `locale`             | Specify [locale](/docs/configuration/localization) for any returned documents.                                                                                                                                                                                                                                                                                        |
+| `select`             | Specify [select](../queries/select) to control which fields to include to the result.                                                                                                                                                                                                                                                                                 |
+| `populate`           | Specify [populate](../queries/select#populate) to control which fields to include to the result from populated documents.                                                                                                                                                                                                                                             |
+| `fallbackLocale`     | Specify a [fallback locale](/docs/configuration/localization) to use for any returned documents.                                                                                                                                                                                                                                                                      |
+| `overrideAccess`     | Skip access control. By default, this property is set to true within all Local API operations.                                                                                                                                                                                                                                                                        |
+| `overrideLock`       | By default, document locks are ignored (`true`). Set to `false` to enforce locks and prevent operations when a document is locked by another user. [More details](../admin/locked-documents).                                                                                                                                                                         |
+| `user`               | If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.                                                                                                                                                                                                                                                                 |
+| `showHiddenFields`   | Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.                                                                                                                                                                                                                                                  |
+| `pagination`         | Set to false to return all documents and avoid querying for document counts.                                                                                                                                                                                                                                                                                          |
+| `context`            | [Context](/docs/hooks/context), which will then be passed to `context` and `req.context`, which can be read by hooks. Useful if you want to pass additional information to the hooks which shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook to determine if it should run or not. |
+| `disableErrors`      | When set to `true`, errors will not be thrown. Instead, the `findByID` operation will return `null`, and the `find` operation will return an empty documents array.                                                                                                                                                                                                   |
+| `disableTransaction` | When set to `true`, a [database transactions](../database/transactions) will not be initialized.                                                                                                                                                                                                                                                                      |
 
 _There are more options available on an operation by operation basis outlined below._
 
+## Transactions
+
+When your database uses transactions you need to thread req through to all local operations. Postgres uses transactions and MongoDB uses transactions when you are using replica sets. Passing req without transactions is still recommended.
+
+```js
+const post = await payload.find({
+  collection: 'posts',
+  req, // passing req is recommended
+})
+```
+
 <Banner type="warning">
   <strong>Note:</strong>
   <br />

docs/plugins/form-builder.mdx

@@ -343,12 +343,12 @@ Maps to a `checkbox` input on your front-end. Used to collect a boolean value.
 Maps to a `number` input on your front-end. Used to collect a number.
 
 | Property       | Type     | Description                                          |
-| -------------- | -------- | ---------------------------------------------------- | --- | -------------- | ------ | ------------------------------- |
+| -------------- | -------- | ---------------------------------------------------- |
 | `name`         | string   | The name of the field.                               |
 | `label`        | string   | The label of the field.                              |
-| `defaultValue` | string   | The default value of the field.                      |
+| `defaultValue` | number   | The default value of the field.                      |
 | `width`        | string   | The width of the field on the front-end.             |
-| `required`     | checkbox | Whether or not the field is required when submitted. |     | `defaultValue` | number | The default value of the field. |
+| `required`     | checkbox | Whether or not the field is required when submitted. |
 
 ### Message
 
@@ -416,7 +416,7 @@ This plugin relies on the [email configuration](../email/overview) defined in yo
 
 ### Email formatting
 
-The email contents supports rich text which will be serialised to HTML on the server before being sent. By default it reads the global configuration of your rich text editor.
+The email contents supports rich text which will be serialized to HTML on the server before being sent. By default it reads the global configuration of your rich text editor.
 
 The email subject and body supports inserting dynamic fields from the form submission data using the `{{field_name}}` syntax. For example, if you have a field called `name` in your form, you can include this in the email body like so:
 

docs/plugins/search.mdx

@@ -81,6 +81,10 @@ export default config
 
 The `collections` property is an array of collection slugs to enable syncing to search. Enabled collections receive a `beforeChange` and `afterDelete` hook that creates, updates, and deletes its respective search record as it changes over time.
 
+### `localize`
+
+By default, the search plugin will add `localization: true` to the `title` field of the newly added `search` collection if you have localization enabled. If you would like to disable this behavior, you can set this to `false`.
+
 #### `defaultPriorities`
 
 This plugin automatically adds a `priority` field to the `search` collection that can be used as the `?sort=` parameter in your queries. For example, you may want to list blog posts before pages. Or you may want one specific post to always take appear first.
@@ -139,7 +143,8 @@ Before creating or updating a search record, the `beforeSync` function runs. Thi
   searchPlugin({
     beforeSync: ({ originalDoc, searchDoc }) => ({
       ...searchDoc,
-      // Modify your docs in any way here, this can be async
+      // - Modify your docs in any way here, this can be async
+      // - You also need to add the `excerpt` field in the `searchOverrides` config
       excerpt: originalDoc?.excerpt || 'This is a fallback excerpt',
     }),
   }),

docs/plugins/seo.mdx

@@ -89,12 +89,23 @@ An array of global slugs to enable SEO. Enabled globals receive a `meta` field w
 
 ##### `fields`
 
-An array of fields that allows you to inject your own custom fields onto the `meta` field group. The following fields are provided by default:
+A function that takes in the default fields via an object and expects an array of fields in return. You can use this to modify existing fields or add new ones.
 
-- `title`: text
-- `description`: textarea
-- `image`: upload (if an `uploadsCollection` is provided)
-- `preview`: ui
+```ts
+// payload.config.ts
+{
+  // ...
+  seoPlugin({
+    fields: ({ defaultFields }) => [
+      ...defaultFields,
+      {
+        name: 'customField',
+        type: 'text',
+      }
+    ]
+  })
+}
+```
 
 ##### `uploadsCollection`
 
@@ -209,25 +220,6 @@ Rename the meta group interface name that is generated for TypeScript and GraphQ
 }
 ```
 
-#### `fieldOverrides`
-
-Pass any valid field props to the base fields: Title, Description or Image.
-
-```ts
-// payload.config.ts
-seoPlugin({
-  // ...
-  fieldOverrides: {
-    title: {
-      required: true,
-    },
-    description: {
-      localized: true,
-    },
-  },
-})
-```
-
 ## Direct use of fields
 
 There is the option to directly import any of the fields from the plugin so that you can include them anywhere as needed.

docs/queries/overview.mdx

@@ -37,21 +37,23 @@ _The exact query syntax will depend on the API you are using, but the concepts a
 
 The following operators are available for use in queries:
 
-| Operator             | Description                                                                                                                                                                       |
-| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `equals`             | The value must be exactly equal.                                                                                                                                                  |
-| `not_equals`         | The query will return all documents where the value is not equal.                                                                                                                 |
-| `greater_than`       | For numeric or date-based fields.                                                                                                                                                 |
-| `greater_than_equal` | For numeric or date-based fields.                                                                                                                                                 |
-| `less_than`          | For numeric or date-based fields.                                                                                                                                                 |
-| `less_than_equal`    | For numeric or date-based fields.                                                                                                                                                 |
-| `like`               | Case-insensitive string must be present. If string of words, all words must be present, in any order.                                                                             |
-| `contains`           | Must contain the value entered, case-insensitive.                                                                                                                                 |
-| `in`                 | The value must be found within the provided comma-delimited list of values.                                                                                                       |
-| `not_in`             | The value must NOT be within the provided comma-delimited list of values.                                                                                                         |
-| `all`                | The value must contain all values provided in the comma-delimited list.                                                                                                           |
-| `exists`             | Only return documents where the value either exists (`true`) or does not exist (`false`).                                                                                         |
-| `near`               | For distance related to a [Point Field](../fields/point) comma separated as `<longitude>, <latitude>, <maxDistance in meters (nullable)>, <minDistance in meters (nullable)>`. |
+| Operator             | Description                                                                                                                                                                         |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `equals`             | The value must be exactly equal.                                                                                                                                                    |
+| `not_equals`         | The query will return all documents where the value is not equal.                                                                                                                   |
+| `greater_than`       | For numeric or date-based fields.                                                                                                                                                   |
+| `greater_than_equal` | For numeric or date-based fields.                                                                                                                                                   |
+| `less_than`          | For numeric or date-based fields.                                                                                                                                                   |
+| `less_than_equal`    | For numeric or date-based fields.                                                                                                                                                   |
+| `like`               | Case-insensitive string must be present. If string of words, all words must be present, in any order.                                                                               |
+| `contains`           | Must contain the value entered, case-insensitive.                                                                                                                                   |
+| `in`                 | The value must be found within the provided comma-delimited list of values.                                                                                                         |
+| `not_in`             | The value must NOT be within the provided comma-delimited list of values.                                                                                                           |
+| `all`                | The value must contain all values provided in the comma-delimited list.                                                                                                             |
+| `exists`             | Only return documents where the value either exists (`true`) or does not exist (`false`).                                                                                           |
+| `near`               | For distance related to a [Point Field](../fields/point) comma separated as `<longitude>, <latitude>, <maxDistance in meters (nullable)>, <minDistance in meters (nullable)>`.      |
+| `within`             | For [Point Fields](../fields/point) to filter documents based on whether points are inside of the given area defined in GeoJSON. [Example](../fields/point#querying-within)         |
+| `intersects`         | For [Point Fields](../fields/point) to filter documents based on whether points intersect with the given area  defined in GeoJSON. [Example](../fields/point#querying-intersects)   |
 
 <Banner type="success">
   <strong>Tip:</strong>
@@ -151,7 +153,7 @@ With the [REST API](../rest-api/overview), you can use the full power of Payload
 
 To understand the syntax, you need to understand that complex URL search strings are parsed into a JSON object. This one isn't too bad, but more complex queries get unavoidably more difficult to write.
 
-For this reason, we recommend to use the extremely helpful and ubiquitous [`qs`](https://www.npmjs.com/package/qs) package to parse your JSON / object-formatted queries into query strings:
+For this reason, we recommend to use the extremely helpful and ubiquitous [`qs-esm`](https://www.npmjs.com/package/qs-esm) package to parse your JSON / object-formatted queries into query strings:
 
 ```ts
 import { stringify } from 'qs-esm'

docs/queries/select.mdx

@@ -0,0 +1,170 @@
+---
+title: Select
+label: Select
+order: 30
+desc: Payload select determines which fields are selected to the result.
+keywords: query, documents, pagination, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+By default, Payload's APIs will return _all fields_ for a given collection or global. But, you may not need all of that data for all of your queries. Sometimes, you might want just a few fields from the response, which can speed up the Payload API and reduce the amount of JSON that is sent to you from the API.
+
+This is where Payload's `select` feature comes in. Here, you can define exactly which fields you'd like to retrieve from the API.
+
+## Local API
+
+To specify `select` in the [Local API](../local-api/overview), you can use the `select` option in your query:
+
+```ts
+// Include mode
+const getPosts = async () => {
+  const posts = await payload.find({
+    collection: 'posts',
+    select: {
+      text: true,
+      // select a specific field from group
+      group: {
+        number: true
+      },
+      // select all fields from array
+      array: true,
+    }, // highlight-line
+  })
+
+  return posts
+}
+
+// Exclude mode
+const getPosts = async () => {
+  const posts = await payload.find({
+    collection: 'posts',
+    // Select everything except for array and group.number
+    select: {
+      array: false,
+      group: {
+        number: false
+      }
+    }, // highlight-line
+  })
+
+  return posts
+}
+```
+
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  To perform querying with `select` efficiently, Payload implements your `select` query on the database level. Because of that, your `beforeRead` and `afterRead` hooks may not receive the full `doc`.
+</Banner>
+
+
+## REST API
+
+To specify select in the [REST API](../rest-api/overview), you can use the `select` parameter in your query:
+
+```ts
+fetch('https://localhost:3000/api/posts?select[color]=true&select[group][number]=true') // highlight-line
+  .then((res) => res.json())
+  .then((data) => console.log(data))
+```
+
+To understand the syntax, you need to understand that complex URL search strings are parsed into a JSON object. This one isn't too bad, but more complex queries get unavoidably more difficult to write.
+
+For this reason, we recommend to use the extremely helpful and ubiquitous [`qs-esm`](https://www.npmjs.com/package/qs-esm) package to parse your JSON / object-formatted queries into query strings:
+
+```ts
+import { stringify } from 'qs-esm'
+
+const select = {
+  text: true,
+  group: {
+    number: true
+  }
+  // This query could be much more complex
+  // and QS would handle it beautifully
+}
+
+const getPosts = async () => {
+  const stringifiedQuery = stringify(
+    {
+      select, // ensure that `qs` adds the `select` property, too!
+    },
+    { addQueryPrefix: true },
+  )
+
+  const response = await fetch(`http://localhost:3000/api/posts${stringifiedQuery}`)
+  // Continue to handle the response below...
+}
+```
+
+<Banner type="info">
+  <strong>Reminder:</strong>
+  This is the same for [Globals](../configuration/globals) using the `/api/globals` endpoint.
+</Banner>
+
+
+## defaultPopulate collection config property
+
+The `defaultPopulate` property allows you specify which fields to select when populating the collection from another document.
+This is especially useful for links where only the `slug` is needed instead of the entire document.
+
+With this feature, you can dramatically reduce the amount of JSON that is populated from [Relationship](/docs/beta/fields/relationship) or [Upload](/docs/beta/fields/upload) fields.
+
+For example, in your content model, you might have a `Link` field which links out to a different page. When you go to retrieve these links, you really only need the `slug` of the page. 
+
+Loading all of the page content, its related links, and everything else is going to be overkill and will bog down your Payload APIs. Instead, you can define the `defaultPopulate` property on your `Pages` collection, so that when Payload "populates" a related Page, it only selects the `slug` field and therefore returns significantly less JSON:
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+import { lexicalEditor, LinkFeature } from '@payloadcms/richtext-lexical'
+import { slateEditor } from '@payloadcms/richtext-slate'
+
+// The TSlug generic can be passed to have type safety for `defaultPopulate`.
+// If avoided, the `defaultPopulate` type resolves to `SelectType`.
+export const Pages: CollectionConfig<'pages'> = {
+  slug: 'pages',
+  // Specify `select`.
+  defaultPopulate: {
+    slug: true,
+  },
+  fields: [
+    {
+      name: 'slug',
+      type: 'text',
+      required: true,
+    },
+  ],
+}
+```
+
+## populate
+
+Setting `defaultPopulate` will enforce that each time Payload performs a "population" of a related document, only the fields specified will be queried and returned. However, you can override `defaultPopulate` with the `populate` property in the Local and REST API:
+
+**Local API:**
+
+```ts
+const getPosts = async () => {
+  const posts = await payload.find({
+    collection: 'posts',
+    populate: {
+      // Select only `text` from populated docs in the "pages" collection
+      // Now, no matter what the `defaultPopulate` is set to on the "pages" collection,
+      // it will be overridden, and the `text` field will be returned instead.
+      pages: {
+        text: true,
+      }, // highlight-line
+    },
+  })
+
+  return posts
+}
+```
+
+**REST API:**
+
+```ts
+fetch('https://localhost:3000/api/posts?populate[pages][text]=true') // highlight-line
+  .then((res) => res.json())
+  .then((data) => console.log(data))
+```

docs/queries/sort.mdx

@@ -6,7 +6,7 @@ desc: Payload sort allows you to order your documents by a field in ascending or
 keywords: query, documents, pagination, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Documents in Payload can be easily sorted by a specific [Field](../fields/overview). When querying Documents, you can pass the name of any top-level field, and the response will sort the Documents by that field in _ascending_ order. If prefixed with a minus symbol ("-"), they will be sorted in _descending_ order. In Local API multiple fields can be specificed by using an array of strings. In REST API multiple fields can be specified by separating fields with comma. The minus symbol can be in front of individual fields.
+Documents in Payload can be easily sorted by a specific [Field](../fields/overview). When querying Documents, you can pass the name of any top-level field, and the response will sort the Documents by that field in _ascending_ order. If prefixed with a minus symbol ("-"), they will be sorted in _descending_ order. In Local API multiple fields can be specified by using an array of strings. In REST API multiple fields can be specified by separating fields with comma. The minus symbol can be in front of individual fields.
 
 Because sorting is handled by the database, the field cannot be a [Virtual Field](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges). It must be stored in the database to be searchable.
 

docs/rest-api/overview.mdx

@@ -18,6 +18,8 @@ All Payload API routes are mounted and prefixed to your config's `routes.api` UR
 - [depth](../queries/depth) - automatically populates relationships and uploads
 - [locale](/docs/configuration/localization#retrieving-localized-docs) - retrieves document(s) in a specific locale
 - [fallback-locale](/docs/configuration/localization#retrieving-localized-docs) - specifies a fallback locale if no locale value exists
+- [select](../queries/select) - specifies which fields to include to the result
+- [populate](../queries/select#populate) - specifies which fields to include to the result from populated documents
 
 ## Collections
 

docs/upload/overview.mdx

@@ -98,7 +98,7 @@ _An asterisk denotes that an option is required._
 | **`displayPreview`**           | Enable displaying preview of the uploaded file in Upload fields related to this Collection. Can be locally overridden by `displayPreview` option in Upload field. [More](/docs/fields/upload#config-options).                         |
 | **`externalFileHeaderFilter`** | Accepts existing headers and returns the headers after filtering or modifying.                                                                                                                                                        |
 | **`filesRequiredOnCreate`**    | Mandate file data on creation, default is true.                                                                                                                                                                                       |
-| **`filenameCompoundIndex`**    | Field slugs to use for a compount index instead of the default filename index.
+| **`filenameCompoundIndex`**    | Field slugs to use for a compound index instead of the default filename index.
 | **`focalPoint`**               | Set to `false` to disable the focal point selection tool in the [Admin Panel](../admin/overview). The focal point selector is only available when `imageSizes` or `resizeOptions` are defined. [More](#crop-and-focal-point-selector) |
 | **`formatOptions`**            | An object with `format` and `options` that are used with the Sharp image library to format the upload file. [More](https://sharp.pixelplumbing.com/api-output#toformat)                                                               |
 | **`handlers`**                 | Array of Request handlers to execute when fetching a file, if a handler returns a Response it will be sent to the client. Otherwise Payload will retrieve and send back the file.                                                     |
@@ -140,11 +140,28 @@ export default buildConfig({
 })
 ```
 
+### Custom filename via hooks
+
+You can customize the filename before it's uploaded to the server by using a `beforeOperation` hook.
+
+```ts
+beforeOperation: [
+  ({ req, operation }) => {
+    if ((operation === 'create' || operation === 'update') && req.file) {
+      req.file.name = 'test.jpg'
+    }
+  },
+],
+```
+
+The `req.file` object will have additional information about the file, such as mimeType and extension, and you also have full access to the file data itself.
+The filename from here will also be threaded to image sizes if they're enabled.
+
 ## Image Sizes
 
 If you specify an array of `imageSizes` to your `upload` config, Payload will automatically crop and resize your uploads to fit each of the sizes specified by your config.
 
-The [Admin Panel](../admin/overview) will also automatically display all available files, including width, height, and filesize, for each of your uploaded files.
+The [Admin Panel](../admin/overview) will also automatically display all available files, including width, height, and file size, for each of your uploaded files.
 
 Behind the scenes, Payload relies on [`sharp`](https://sharp.pixelplumbing.com/api-resize#resize) to perform its image resizing. You can specify additional options for `sharp` to use while resizing your images.
 

docs/upload/storage-adapters.mdx

@@ -14,7 +14,7 @@ Payload offers additional storage adapters to handle file uploads. These adapter
 | AWS S3               | [`@payloadcms/storage-s3`](https://github.com/payloadcms/payload/tree/beta/packages/storage-s3)                   |
 | Azure                | [`@payloadcms/storage-azure`](https://github.com/payloadcms/payload/tree/beta/packages/storage-azure)             |
 | Google Cloud Storage | [`@payloadcms/storage-gcs`](https://github.com/payloadcms/payload/tree/beta/packages/storage-gcs)                 |
-
+| Uploadthing          | [`@payloadcms/storage-uploadthing`](https://github.com/payloadcms/payload/tree/beta/packages/uploadthing)         |
 
 ## Vercel Blob Storage
 [`@payloadcms/storage-vercel-blob`](https://www.npmjs.com/package/@payloadcms/storage-vercel-blob)
@@ -43,8 +43,8 @@ export default buildConfig({
       enabled: true, // Optional, defaults to true
       // Specify which collections should use Vercel Blob
       collections: {
-        [Media.slug]: true,
-        [MediaWithPrefix.slug]: {
+        media: true,
+        'media-with-prefix': {
           prefix: 'my-prefix',
         },
       },
@@ -76,7 +76,7 @@ pnpm add @payloadcms/storage-s3@beta
 
 ### Usage
 
-- Configure the `collections` object to specify which collections should use the Vercel Blob adapter. The slug _must_ match one of your existing collection slugs.
+- Configure the `collections` object to specify which collections should use the S3 Storage adapter. The slug _must_ match one of your existing collection slugs.
 - The `config` object can be any [`S3ClientConfig`](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3) object (from [`@aws-sdk/client-s3`](https://github.com/aws/aws-sdk-js-v3)). _This is highly dependent on your AWS setup_. Check the AWS documentation for more information.
 - When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
 
@@ -90,8 +90,8 @@ export default buildConfig({
   plugins: [
     s3Storage({
       collections: {
-        [mediaSlug]: true,
-        [mediaWithPrefixSlug]: {
+        media: true,
+        'media-with-prefix': {
           prefix,
         },
       },
@@ -124,7 +124,7 @@ pnpm add @payloadcms/storage-azure@beta
 
 ### Usage
 
-- Configure the `collections` object to specify which collections should use the Vercel Blob adapter. The slug _must_ match one of your existing collection slugs.
+- Configure the `collections` object to specify which collections should use the Azure Blob adapter. The slug _must_ match one of your existing collection slugs.
 - When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
 
 ```ts
@@ -137,8 +137,8 @@ export default buildConfig({
   plugins: [
     azureStorage({
       collections: {
-        [mediaSlug]: true,
-        [mediaWithPrefixSlug]: {
+        media: true,
+        'media-with-prefix': {
           prefix,
         },
       },
@@ -173,7 +173,7 @@ pnpm add @payloadcms/storage-gcs@beta
 
 ### Usage
 
-- Configure the `collections` object to specify which collections should use the Vercel Blob adapter. The slug _must_ match one of your existing collection slugs.
+- Configure the `collections` object to specify which collections should use the Google Cloud Storage adapter. The slug _must_ match one of your existing collection slugs.
 - When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
 
 ```ts
@@ -186,8 +186,8 @@ export default buildConfig({
   plugins: [
     gcsStorage({
       collections: {
-        [mediaSlug]: true,
-        [mediaWithPrefixSlug]: {
+        media: true,
+        'media-with-prefix': {
           prefix,
         },
       },
@@ -224,7 +224,7 @@ pnpm add @payloadcms/storage-uploadthing@beta
 ### Usage
 
 - Configure the `collections` object to specify which collections should use uploadthing. The slug _must_ match one of your existing collection slugs and be an `upload` type.
-- Get an API key from Uploadthing and set it as `apiKey` in the `options` object.
+- Get a token from Uploadthing and set it as `token` in the `options` object.
 - `acl` is optional and defaults to `public-read`.
 
 ```ts
@@ -233,10 +233,10 @@ export default buildConfig({
   plugins: [
     uploadthingStorage({
       collections: {
-        [mediaSlug]: true,
+        media: true,
       },
       options: {
-        apiKey: process.env.UPLOADTHING_SECRET,
+        token: process.env.UPLOADTHING_TOKEN,
         acl: 'public-read',
       },
     }),
@@ -248,7 +248,7 @@ export default buildConfig({
 
 | Option           | Description                                     | Default       |
 | ---------------- | ----------------------------------------------- | ------------- |
-| `apiKey`         | API key from Uploadthing. Required.             |               |
+| `token`          | Token from Uploadthing. Required.               |               |
 | `acl`            | Access control list for files that are uploaded | `public-read` |
 | `logLevel`       | Log level for Uploadthing                       | `info`        |
 | `fetch`          | Custom fetch function                           | `fetch`       |
@@ -310,7 +310,7 @@ This plugin is configurable to work across many different Payload collections. A
 | Option           | Type                                | Description                                                                                                                       |
 | ---------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
 | `collections` \* | `Record<string, CollectionOptions>` | Object with keys set to the slug of collections you want to enable the plugin for, and values set to collection-specific options. |
-| `enabled`        |                                     | `boolean` to conditionally enable/disable plugin. Default: true.                                                                  |
+| `enabled`        | `boolean`                           | To conditionally enable/disable plugin. Default: `true`.                                                                          |
 
 ## Collection-specific options
 

examples/auth/payload/src/app/(payload)/api/graphql/route.ts

@@ -1,6 +1,8 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
 /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
 import config from '@payload-config'
-import { GRAPHQL_POST } from '@payloadcms/next/routes'
+import { GRAPHQL_POST, REST_OPTIONS } from '@payloadcms/next/routes'
 
 export const POST = GRAPHQL_POST(config)
+
+export const OPTIONS = REST_OPTIONS(config)

examples/custom-components/src/app/(payload)/api/graphql/route.ts

@@ -1,6 +1,8 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
 /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
 import config from '@payload-config'
-import { GRAPHQL_POST } from '@payloadcms/next/routes'
+import { GRAPHQL_POST, REST_OPTIONS } from '@payloadcms/next/routes'
 
 export const POST = GRAPHQL_POST(config)
+
+export const OPTIONS = REST_OPTIONS(config)

examples/custom-components/src/app/(payload)/layout.tsx

@@ -1,6 +1,6 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
 /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
-import configPromise from '@payload-config'
+import config from '@payload-config'
 import '@payloadcms/next/css'
 import { RootLayout } from '@payloadcms/next/layouts'
 import React from 'react'
@@ -13,7 +13,7 @@ type Args = {
 }
 
 const Layout = ({ children }: Args) => (
-  <RootLayout config={configPromise} importMap={importMap}>
+  <RootLayout config={config} importMap={importMap}>
     {children}
   </RootLayout>
 )

examples/email/.env.example

@@ -1,4 +1,5 @@
-MONGODB_URI=mongodb://127.0.0.1/payload-example-email
-PAYLOAD_SECRET=
+DATABASE_URI=mongodb://127.0.0.1/payload-example-email
 NODE_ENV=development
-PAYLOAD_PUBLIC_SERVER_URL=http://localhost:8000
+PAYLOAD_SECRET=PAYLOAD_EMAIL_EXAMPLE_SECRET_KEY
+PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
+

examples/email/.eslintrc.cjs

@@ -1,7 +1,4 @@
 module.exports = {
   root: true,
   extends: ['@payloadcms'],
-  rules: {
-    '@typescript-eslint/no-unused-vars': 'warn',
-  },
 }

examples/email/.swcrc

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "sourceMaps": true,
+  "jsc": {
+    "target": "esnext",
+    "parser": {
+      "syntax": "typescript",
+      "tsx": true,
+      "dts": true
+    },
+    "transform": {
+      "react": {
+        "runtime": "automatic",
+        "pragmaFrag": "React.Fragment",
+        "throwIfNamespace": true,
+        "development": false,
+        "useBuiltins": true
+      }
+    }
+  },
+  "module": {
+    "type": "es6"
+  }
+}

examples/email/README.md

@@ -7,30 +7,31 @@ This example demonstrates how to integrate email functionality into Payload.
 To spin up this example locally, follow these steps:
 
 1. Clone this repo
-2. `cd` into this directory and run `yarn` or `npm install`
-3. `cp .env.example .env` to copy the example environment variables
+2. `cp .env.example .env` to copy the example environment variables
+3. `pnpm install && pnpm dev` to install dependencies and start the dev server
 4. `yarn dev` or `npm run dev` to start the server and seed the database
-5. `open http://localhost:8000/admin` to access the admin panel
+5. open `http://localhost:3000/admin` to access the admin panel
 6. Create your first user
 
 ## How it works
 
-Payload utilizes [NodeMailer](https://nodemailer.com/about/) for email functionality. Once you add your email configuration to `payload.init()`, you send email from anywhere in your application just by calling `payload.sendEmail({})`.
+Email functionality in Payload is configured using adapters. The recommended adapter for most use cases is the [@payloadcms/email-nodemailer](https://www.npmjs.com/package/@payloadcms/email-nodemailer) package.
 
-1. Navigate to `src/server.ts` - this is where your email config gets passed to Payload
-2. Open `src/email/transport.ts` - here we are defining the email config. You can use an env variable to switch between the mock email transport and live email service.
+To enable email, pass your adapter configuration to the `email` property in the Payload Config. This allows Payload to send auth-related emails for password resets, new user verifications, and other email needs.
+
+1. In the Payload Config file, add your email adapter to the `email` property. For example, the `@payloadcms/email-nodemailer` adapter can be configured for SMTP, SendGrid, or other supported transports. During development, if no configuration is provided, Payload will use a mock service via [ethereal.email](ethereal.email).
 
 Now we can start sending email!
 
-3. Go to `src/collections/Newsletter.ts` - with an `afterChange` hook, we are sending an email when a new user signs up for the newsletter
+2. Go to `src/collections/Newsletter.ts` - with an `afterChange` hook, we are sending an email when a new user signs up for the newsletter
 
 Let's not forget our authentication emails...
 
-4. Auth-enabled collections have built-in options to verify the user and reset the user password. Open `src/collections/Users.ts` and see how we customize these emails.
+3. Auth-enabled collections have built-in options to verify the user and reset the user password. Open `src/collections/Users.ts` and see how we customize these emails.
 
 Speaking of customization...
 
-5. Take a look at `src/email/generateEmailHTML` and how it compiles a custom template when sending email. You change this to any HTML template of your choosing.
+4. Take a look at `src/email/generateEmailHTML` and how it compiles a custom template when sending email. You change this to any HTML template of your choosing.
 
 That's all you need, now you can go ahead and test out this repo by creating a new `user` or `newsletter-signup` and see the email integration in action.
 
@@ -40,10 +41,10 @@ To spin up this example locally, follow the [Quick Start](#quick-start).
 
 ## Production
 
-To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:
+To run Payload in production, you need to build and start the Admin panel. To do so, follow these steps:
 
-1. First invoke the `payload build` script by running `yarn build` or `npm run build` in your project root. This creates a `./build` directory with a production-ready admin bundle.
-1. Then run `yarn serve` or `npm run serve` to run Node in production and serve Payload from the `./build` directory.
+1. Invoke the `next build` script by running `pnpm build` or `npm run build` in your project root. This creates a `.next` directory with a production-ready admin bundle.
+1. Finally run `pnpm start` or `npm run start` to run Node in production and serve Payload from the `.build` directory.
 
 ### Deployment
 

examples/email/next-env.d.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

examples/email/next.config.mjs

@@ -0,0 +1,8 @@
+import { withPayload } from '@payloadcms/next/withPayload'
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  // Your Next.js config here
+}
+
+export default withPayload(nextConfig)

examples/email/nodemon.json

@@ -1,5 +0,0 @@
-{
-  "ext": "ts",
-  "exec": "ts-node src/server.ts -- -I",
-  "stdin": false
-}

examples/email/package.json

@@ -1,35 +1,57 @@
 {
   "name": "payload-example-email",
-  "description": "Payload Email integration example.",
   "version": "1.0.0",
-  "main": "dist/server.js",
+  "description": "Payload Email integration example.",
   "license": "MIT",
+  "type": "module",
   "scripts": {
-    "dev": "cross-env PAYLOAD_SEED=true PAYLOAD_DROP_DATABASE=true PAYLOAD_CONFIG_PATH=src/payload.config.ts nodemon",
-    "build:payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload build",
-    "build:server": "tsc",
-    "build": "yarn copyfiles && yarn build:payload && yarn build:server",
-    "serve": "cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NODE_ENV=production node dist/server.js",
-    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png}\" dist/",
-    "generate:types": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:types",
-    "generate:graphQLSchema": "PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema",
-    "lint": "eslint src",
-    "lint:fix": "eslint --fix --ext .ts,.tsx src"
+    "_dev": "cross-env NODE_OPTIONS=--no-deprecation next dev",
+    "build": "cross-env NODE_OPTIONS=--no-deprecation next build",
+    "dev": "cross-env PAYLOAD_SEED=true PAYLOAD_DROP_DATABASE=true NODE_OPTIONS=--no-deprecation next dev",
+    "generate:importmap": "cross-env NODE_OPTIONS=--no-deprecation payload generate:importmap",
+    "generate:schema": "payload-graphql generate:schema",
+    "generate:types": "payload generate:types",
+    "payload": "cross-env NODE_OPTIONS=--no-deprecation payload",
+    "start": "cross-env NODE_OPTIONS=--no-deprecation next start"
   },
   "dependencies": {
+    "@payloadcms/db-mongodb": "beta",
+    "@payloadcms/email-nodemailer": "beta",
+    "@payloadcms/next": "beta",
+    "@payloadcms/richtext-lexical": "beta",
+    "@payloadcms/ui": "beta",
+    "cross-env": "^7.0.3",
     "dotenv": "^8.2.0",
-    "express": "^4.17.1",
-    "payload": "latest",
-    "handlebars": "^4.7.7",
-    "inline-css": "^4.0.2"
+    "ejs": "3.1.10",
+    "graphql": "^16.9.0",
+    "juice": "11.0.0",
+    "next": "15.0.0",
+    "payload": "beta",
+    "react": "19.0.0-rc-65a56d0e-20241020",
+    "react-dom": "19.0.0-rc-65a56d0e-20241020"
   },
   "devDependencies": {
-    "@types/express": "^4.17.9",
-    "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.19.0",
-    "nodemon": "^2.0.6",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.8.4"
+    "@payloadcms/graphql": "beta",
+    "@swc/core": "^1.6.13",
+    "@types/ejs": "^3.1.5",
+    "@types/react": "npm:types-react@19.0.0-rc.1",
+    "@types/react-dom": "npm:types-react-dom@19.0.0-rc.1",
+    "eslint": "^8.57.0",
+    "eslint-config-next": "15.0.0",
+    "tsx": "^4.16.2",
+    "typescript": "5.5.2"
+  },
+  "engines": {
+    "node": "^18.20.2 || >=20.9.0"
+  },
+  "pnpm": {
+    "overrides": {
+      "@types/react": "npm:types-react@19.0.0-rc.1",
+      "@types/react-dom": "npm:types-react-dom@19.0.0-rc.1"
+    }
+  },
+  "overrides": {
+    "@types/react": "npm:types-react@19.0.0-rc.1",
+    "@types/react-dom": "npm:types-react-dom@19.0.0-rc.1"
   }
 }

examples/email/src/app/(payload)/admin/[[...segments]]/not-found.tsx

@@ -0,0 +1,25 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import type { Metadata } from 'next'
+
+import config from '@payload-config'
+import { generatePageMetadata, NotFoundPage } from '@payloadcms/next/views'
+
+import { importMap } from '../importMap'
+
+type Args = {
+  params: Promise<{
+    segments: string[]
+  }>
+  searchParams: Promise<{
+    [key: string]: string | string[]
+  }>
+}
+
+export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
+  generatePageMetadata({ config, params, searchParams })
+
+const NotFound = ({ params, searchParams }: Args) =>
+  NotFoundPage({ config, importMap, params, searchParams })
+
+export default NotFound

examples/email/src/app/(payload)/admin/[[...segments]]/page.tsx

@@ -0,0 +1,25 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import type { Metadata } from 'next'
+
+import config from '@payload-config'
+import { generatePageMetadata, RootPage } from '@payloadcms/next/views'
+
+import { importMap } from '../importMap'
+
+type Args = {
+  params: Promise<{
+    segments: string[]
+  }>
+  searchParams: Promise<{
+    [key: string]: string | string[]
+  }>
+}
+
+export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
+  generatePageMetadata({ config, params, searchParams })
+
+const Page = ({ params, searchParams }: Args) =>
+  RootPage({ config, importMap, params, searchParams })
+
+export default Page

examples/email/src/app/(payload)/admin/importMap.js

@@ -0,0 +1 @@
+export const importMap = {}

examples/email/src/app/(payload)/api/[...slug]/route.ts

@@ -0,0 +1,10 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import config from '@payload-config'
+import { REST_DELETE, REST_GET, REST_OPTIONS, REST_PATCH, REST_POST } from '@payloadcms/next/routes'
+
+export const GET = REST_GET(config)
+export const POST = REST_POST(config)
+export const DELETE = REST_DELETE(config)
+export const PATCH = REST_PATCH(config)
+export const OPTIONS = REST_OPTIONS(config)

examples/email/src/app/(payload)/api/graphql-playground/route.ts

@@ -0,0 +1,6 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import config from '@payload-config'
+import { GRAPHQL_PLAYGROUND_GET } from '@payloadcms/next/routes'
+
+export const GET = GRAPHQL_PLAYGROUND_GET(config)

examples/email/src/app/(payload)/api/graphql/route.ts

@@ -0,0 +1,8 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import config from '@payload-config'
+import { GRAPHQL_POST, REST_OPTIONS } from '@payloadcms/next/routes'
+
+export const POST = GRAPHQL_POST(config)
+
+export const OPTIONS = REST_OPTIONS(config)

examples/email/src/app/(payload)/layout.tsx

@@ -0,0 +1,32 @@
+import type { ServerFunctionClient } from 'payload'
+
+import '@payloadcms/next/css'
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import config from '@payload-config'
+import { handleServerFunctions, RootLayout } from '@payloadcms/next/layouts'
+import React from 'react'
+
+import { importMap } from './admin/importMap.js'
+import './custom.scss'
+
+type Args = {
+  children: React.ReactNode
+}
+
+const serverFunction: ServerFunctionClient = async function (args) {
+  'use server'
+  return handleServerFunctions({
+    ...args,
+    config,
+    importMap,
+  })
+}
+
+const Layout = ({ children }: Args) => (
+  <RootLayout config={config} importMap={importMap} serverFunction={serverFunction}>
+    {children}
+  </RootLayout>
+)
+
+export default Layout

examples/email/src/collections/Newsletter.ts

@@ -1,28 +1,12 @@
-import type { CollectionConfig } from 'payload/types'
-import generateEmailHTML from '../email/generateEmailHTML'
+import type { CollectionConfig } from 'payload'
 
-const Newsletter: CollectionConfig = {
+import { generateEmailHTML } from '../email/generateEmailHTML'
+
+export const Newsletter: CollectionConfig = {
   slug: 'newsletter-signups',
   admin: {
     defaultColumns: ['name', 'email'],
   },
-  hooks: {
-    afterChange: [
-      async ({ doc, operation, req }) => {
-        if (operation === 'create') {
-          req.payload.sendEmail({
-            to: doc.email,
-            from: 'sender@example.com',
-            subject: 'Thanks for signing up!',
-            html: await generateEmailHTML({
-              headline: 'Welcome to the newsletter!',
-              content: `<p>${doc.name ? `Hi ${doc.name}!` : 'Hi!'} We'll be in touch soon...</p>`,
-            }),
-          })
-        }
-      },
-    ],
-  },
   fields: [
     {
       name: 'name',
@@ -34,6 +18,25 @@ const Newsletter: CollectionConfig = {
       required: true,
     },
   ],
+  hooks: {
+    afterChange: [
+      async ({ doc, operation, req }) => {
+        if (operation === 'create') {
+          req.payload
+            .sendEmail({
+              from: 'sender@example.com',
+              html: await generateEmailHTML({
+                content: `<p>${doc.name ? `Hi ${doc.name}!` : 'Hi!'} We'll be in touch soon...</p>`,
+                headline: 'Welcome to the newsletter!',
+              }),
+              subject: 'Thanks for signing up!',
+              to: doc.email,
+            })
+            .catch((error) => {
+              console.error('Error sending email:', error)
+            })
+        }
+      },
+    ],
+  },
 }
-
-export default Newsletter

examples/email/src/collections/Users.ts

@@ -1,23 +1,23 @@
-import type { CollectionConfig } from 'payload/types'
+import type { CollectionConfig } from 'payload'
 
-import generateForgotPasswordEmail from '../email/generateForgotPasswordEmail'
-import generateVerificationEmail from '../email/generateVerificationEmail'
+import { generateForgotPasswordEmail } from '../email/generateForgotPasswordEmail'
+import { generateVerificationEmail } from '../email/generateVerificationEmail'
 
-const Users: CollectionConfig = {
+export const Users: CollectionConfig = {
   slug: 'users',
-  auth: {
-    verify: {
-      generateEmailSubject: () => 'Verify your email',
-      generateEmailHTML: generateVerificationEmail,
-    },
-    forgotPassword: {
-      generateEmailSubject: () => 'Reset your password',
-      generateEmailHTML: generateForgotPasswordEmail,
-    },
-  },
   admin: {
     useAsTitle: 'email',
   },
+  auth: {
+    forgotPassword: {
+      generateEmailHTML: generateForgotPasswordEmail,
+      generateEmailSubject: () => 'Reset your password',
+    },
+    verify: {
+      generateEmailHTML: generateVerificationEmail,
+      generateEmailSubject: () => 'Verify your email',
+    },
+  },
   fields: [
     {
       name: 'name',
@@ -25,5 +25,3 @@ const Users: CollectionConfig = {
     },
   ],
 }
-
-export default Users

examples/email/src/email/generateEmailHTML.ts

@@ -1,24 +1,17 @@
+import ejs from 'ejs'
 import fs from 'fs'
-import Handlebars from 'handlebars'
-import inlineCSS from 'inline-css'
+import juice from 'juice'
 import path from 'path'
 
-const template = fs.readFileSync
-  ? fs.readFileSync(path.join(__dirname, './template.html'), 'utf8')
-  : ''
+export const generateEmailHTML = async (data: any): Promise<string> => {
+  const templatePath = path.join(process.cwd(), 'src/email/template.ejs')
+  const templateContent = fs.readFileSync(templatePath, 'utf8')
 
-// Compile the template
-const getHTML = Handlebars.compile(template)
+  // Compile and render the template with EJS
+  const preInlinedCSS = ejs.render(templateContent, { ...data, cta: data.cta || {} })
 
-const generateEmailHTML = async (data): Promise<string> => {
-  const preInlinedCSS = getHTML(data)
+  // Inline CSS
+  const html = juice(preInlinedCSS)
 
-  const html = await inlineCSS(preInlinedCSS, {
-    url: ' ',
-    removeStyleTags: false,
-  })
-
-  return html
+  return Promise.resolve(html)
 }
-
-export default generateEmailHTML

examples/email/src/email/generateForgotPasswordEmail.ts

@@ -1,13 +1,24 @@
-import generateEmailHTML from './generateEmailHTML'
+import type { PayloadRequest } from 'payload'
 
-const generateForgotPasswordEmail = async ({ token }): Promise<string> =>
-  generateEmailHTML({
-    headline: 'Locked out?',
+import { generateEmailHTML } from './generateEmailHTML'
+
+type ForgotPasswordEmailArgs =
+  | {
+      req?: PayloadRequest
+      token?: string
+      user?: any
+    }
+  | undefined
+
+export const generateForgotPasswordEmail = async (
+  args: ForgotPasswordEmailArgs,
+): Promise<string> => {
+  return generateEmailHTML({
     content: '<p>Let&apos;s get you back in.</p>',
     cta: {
       buttonLabel: 'Reset your password',
-      url: `${process.env.PAYLOAD_PUBLIC_SERVER_URL}/reset-password?token=${token}`,
+      url: `${process.env.PAYLOAD_PUBLIC_SERVER_URL}/reset-password?token=${args?.token}`,
     },
+    headline: 'Locked out?',
   })
-
-export default generateForgotPasswordEmail
+}

examples/email/src/email/generateVerificationEmail.ts

@@ -1,16 +1,26 @@
-import generateEmailHTML from './generateEmailHTML'
+import { generateEmailHTML } from './generateEmailHTML'
 
-const generateVerificationEmail = async (args): Promise<string> => {
-  const { user, token } = args
+type User = {
+  email: string
+  name?: string
+}
+
+type GenerateVerificationEmailArgs = {
+  token: string
+  user: User
+}
+
+export const generateVerificationEmail = async (
+  args: GenerateVerificationEmailArgs,
+): Promise<string> => {
+  const { token, user } = args
 
   return generateEmailHTML({
-    headline: 'Verify your account',
     content: `<p>Hi${user.name ? ' ' + user.name : ''}! Validate your account by clicking the button below.</p>`,
     cta: {
       buttonLabel: 'Verify',
       url: `${process.env.PAYLOAD_PUBLIC_SERVER_URL}/verify?token=${token}&email=${user.email}`,
     },
+    headline: 'Verify your account',
   })
 }
-
-export default generateVerificationEmail