Merge remote-tracking branch 'origin/2.x' into remove-docs

Reverts payloadcms/payload#8110

.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'
+        - '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,41 @@
+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/release-commenter/.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/eslint-recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+}

.github/actions/release-commenter/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  printWidth: 100,
+  parser: 'typescript',
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+  arrowParens: 'avoid',
+}

.github/actions/release-commenter/README.md

@@ -0,0 +1,74 @@
+# Release Commenter
+
+This GitHub Action automatically comments on and/or labels Issues and PRs when a fix is released for them.
+
+> [!IMPORTANT]
+> 🔧 Heavily modified version of https://github.com/apexskier/github-release-commenter
+
+## Fork Modifications
+
+- Filters to closed PRs only
+- Adds tag filter to support non-linear releases
+- Better logging
+- Moved to pnpm
+- Uses @vercel/ncc for packaging
+- Comments on locked issues by unlocking then re-locking
+
+## How it works
+
+Use this action in a workflow [triggered by a release](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#release). It will scan commits between that and the prior release, find associated Issues and PRs, and comment on them to let people know a release has been made. Associated Issues and PRs can be directly [linked](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) to the commit or manually linked from a PR associated with the commit.
+
+## Inputs
+
+**GITHUB_TOKEN**
+
+A GitHub personal access token with repo scope, such as [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#about-the-github_token-secret).
+
+**comment-template** (optional)
+
+Override the comment posted on Issues and PRs. Set to the empty string to disable commenting. Several variables strings will be automatically replaced:
+
+- `{release_link}` - a markdown link to the release
+- `{release_name}` - the release's name
+- `{release_tag}` - the release's tag
+
+**label-template** (optional)
+
+Add the given label. Multiple labels can be separated by commas. Several variable strings will be automatically replaced:
+
+- `{release_name}` - the release's name
+- `{release_tag}` - the release's tag
+
+**skip-label** (optional)
+
+Skip processing if any of the given labels are present. Same processing rules as **label-template**. Default is "dependencies".
+
+## Example
+
+```yml
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    steps:
+      - uses: apexskier/github-release-commenter@v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          comment-template: |
+            Release {release_link} addresses this.
+```
+
+## Known limitations
+
+These are some known limitations of this action. I'd like to try to address them in the future.
+
+- Non-linear releases aren't supported. For example, releasing a patch to a prior major release after a new major release has been bumped.
+- Non-sequential releases aren't supported. For example, if you release multiple prereleases between two official releases, this will only create a comment for the first prerelease in which a fix is released, not the final release.
+- The first release for a project will be ignored. This is intentional, as the use case is unlikely. Most projects will either have several alphas that don't need release comments, or won't use issues/PRs for the first commit.
+- If a large number of things are commented on, you may see the error `Error: You have triggered an abuse detection mechanism. Please wait a few minutes before you try again.`. Consider using the `skip-label` input to reduce your load on the GitHub API.
+
+## Versions
+
+Workflows will automatically update the tags `v1` and `latest`, allowing you to reference one of those instead of locking to a specific release.

.github/actions/release-commenter/action.yml

@@ -0,0 +1,32 @@
+name: Release Commenter
+description: Comment on PRs and Issues when a fix is released
+branding:
+  icon: message-square
+  color: blue
+inputs:
+  GITHUB_TOKEN:
+    description: |
+      A GitHub personal access token with repo scope, such as
+      secrets.GITHUB_TOKEN.
+    required: true
+  comment-template:
+    description: |
+      Text template for the comment string.
+    required: false
+    default: |
+      Included in release {release_link}
+  label-template:
+    description: Add the given label. Multiple labels can be separated by commas.
+    required: false
+  skip-label:
+    description: Skip commenting if any of the given label are present. Multiple labels can be separated by commas.
+    required: false
+    default: "dependencies"
+  tag-filter:
+    description: |
+      Filter tags by a regular expression. Must be escaped. e.g. 'v\\d' to isolate tags between major versions.
+    required: false
+    default: null
+runs:
+  using: node20
+  main: dist/index.js

.github/actions/release-commenter/jest.config.js

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

.github/actions/release-commenter/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "release-commenter",
+  "version": "0.0.0",
+  "description": "GitHub Action to automatically comment on PRs and Issues when a fix is released.",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "private": true,
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "pnpm build:typecheck && pnpm build:ncc",
+    "build:ncc": "ncc build src/index.ts -t -o dist",
+    "build:typecheck": "tsc",
+    "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/release-commenter/src/__snapshots__/index.test.ts.snap

@@ -0,0 +1,266 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`tests feature tests can apply labels 1`] = `
+[
+  [
+    {
+      "issue_number": 123,
+      "labels": [
+        ":dart: landed",
+        "release-current_tag_name",
+        "Release Name",
+      ],
+    },
+  ],
+  [
+    {
+      "issue_number": 7,
+      "labels": [
+        ":dart: landed",
+        "release-current_tag_name",
+        "Release Name",
+      ],
+    },
+  ],
+]
+`;
+
+exports[`tests main test 1`] = `
+{
+  "graphql": [MockFunction] {
+    "calls": [
+      [
+        "
+            {
+              resource(url: "http://repository/commit/SHA1") {
+                ... on Commit {
+                  messageHeadlineHTML
+                  messageBodyHTML
+                  associatedPullRequests(first: 10) {
+                    pageInfo {
+                      hasNextPage
+                    }
+                    edges {
+                      node {
+                        bodyHTML
+                        number
+                        state
+                        labels(first: 10) {
+                          pageInfo {
+                            hasNextPage
+                          }
+                          nodes {
+                            name
+                          }
+                        }
+                        timelineItems(itemTypes: [CONNECTED_EVENT, DISCONNECTED_EVENT], first: 100) {
+                          pageInfo {
+                            hasNextPage
+                          }
+                          nodes {
+                            ... on ConnectedEvent {
+                              __typename
+                              isCrossRepository
+                              subject {
+                                ... on Issue {
+                                  number
+                                }
+                              }
+                            }
+                            ... on DisconnectedEvent {
+                              __typename
+                              isCrossRepository
+                              subject {
+                                ... on Issue {
+                                  number
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          ",
+      ],
+      [
+        "
+            {
+              resource(url: "http://repository/commit/SHA2") {
+                ... on Commit {
+                  messageHeadlineHTML
+                  messageBodyHTML
+                  associatedPullRequests(first: 10) {
+                    pageInfo {
+                      hasNextPage
+                    }
+                    edges {
+                      node {
+                        bodyHTML
+                        number
+                        state
+                        labels(first: 10) {
+                          pageInfo {
+                            hasNextPage
+                          }
+                          nodes {
+                            name
+                          }
+                        }
+                        timelineItems(itemTypes: [CONNECTED_EVENT, DISCONNECTED_EVENT], first: 100) {
+                          pageInfo {
+                            hasNextPage
+                          }
+                          nodes {
+                            ... on ConnectedEvent {
+                              __typename
+                              isCrossRepository
+                              subject {
+                                ... on Issue {
+                                  number
+                                }
+                              }
+                            }
+                            ... on DisconnectedEvent {
+                              __typename
+                              isCrossRepository
+                              subject {
+                                ... on Issue {
+                                  number
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          ",
+      ],
+    ],
+    "results": [
+      {
+        "type": "return",
+        "value": Promise {},
+      },
+      {
+        "type": "return",
+        "value": Promise {},
+      },
+    ],
+  },
+  "rest": {
+    "issues": {
+      "addLabels": [MockFunction],
+      "createComment": [MockFunction] {
+        "calls": [
+          [
+            {
+              "body": "Included in release [current_tag_name](http://current_release). Replacements: current_tag_name, current_tag_name.",
+              "issue_number": 3,
+            },
+          ],
+          [
+            {
+              "body": "Included in release [current_tag_name](http://current_release). Replacements: current_tag_name, current_tag_name.",
+              "issue_number": 123,
+            },
+          ],
+          [
+            {
+              "body": "Included in release [current_tag_name](http://current_release). Replacements: current_tag_name, current_tag_name.",
+              "issue_number": 7,
+            },
+          ],
+        ],
+        "results": [
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+        ],
+      },
+      "get": [MockFunction] {
+        "calls": [
+          [
+            {
+              "issue_number": 3,
+            },
+          ],
+          [
+            {
+              "issue_number": 123,
+            },
+          ],
+          [
+            {
+              "issue_number": 7,
+            },
+          ],
+        ],
+        "results": [
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+        ],
+      },
+    },
+    "repos": {
+      "compareCommits": [MockFunction] {
+        "calls": [
+          [
+            {
+              "base": "prior_tag_name",
+              "head": "current_tag_name",
+            },
+          ],
+        ],
+        "results": [
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+        ],
+      },
+      "listReleases": [MockFunction] {
+        "calls": [
+          [
+            {
+              "per_page": 100,
+            },
+          ],
+        ],
+        "results": [
+          {
+            "type": "return",
+            "value": Promise {},
+          },
+        ],
+      },
+    },
+  },
+}
+`;

.github/actions/release-commenter/src/index.test.ts

@@ -0,0 +1,399 @@
+import type * as githubModule from '@actions/github'
+import type * as coreModule from '@actions/core'
+import { mock } from 'node:test'
+
+jest.mock('@actions/core')
+jest.mock('@actions/github')
+
+type Mocked<T> = {
+  -readonly [P in keyof T]: T[P] extends Function ? jest.Mock<T[P]> : jest.Mocked<Partial<T[P]>>
+}
+
+const github = require('@actions/github') as jest.Mocked<Mocked<typeof githubModule>>
+const core = require('@actions/core') as jest.Mocked<Mocked<typeof coreModule>>
+
+describe('tests', () => {
+  let mockOctokit: any = {}
+  let currentTag: string = 'current_tag_name'
+
+  ;(core.warning as any) = jest.fn(console.warn.bind(console))
+  ;(core.error as any) = jest.fn(console.error.bind(console))
+
+  let commentTempate: string = ''
+  let labelTemplate: string | null = null
+  const skipLabelTemplate: string | null = 'skip,test'
+  let tagFilter: string | RegExp | null = null
+
+  let simpleMockOctokit: any = {}
+
+  beforeEach(() => {
+    tagFilter = null
+    currentTag = 'current_tag_name'
+    ;(github.context as any) = {
+      payload: {
+        repo: {
+          owner: 'owner',
+          repo: 'repo',
+        },
+        release: {
+          tag_name: currentTag,
+        },
+        repository: { html_url: 'http://repository' },
+      },
+    }
+
+    github.getOctokit.mockReset().mockImplementationOnce(((token: string) => {
+      expect(token).toBe('GITHUB_TOKEN_VALUE')
+      return mockOctokit
+    }) as any)
+    ;(core.getInput as any).mockImplementation((key: string) => {
+      if (key == 'GITHUB_TOKEN') {
+        return 'GITHUB_TOKEN_VALUE'
+      }
+      if (key == 'comment-template') {
+        return commentTempate
+      }
+      if (key == 'label-template') {
+        return labelTemplate
+      }
+      if (key == 'skip-label') {
+        return skipLabelTemplate
+      }
+      if (key == 'tag-filter') {
+        return tagFilter
+      }
+      fail(`Unexpected input key ${key}`)
+    })
+
+    commentTempate =
+      'Included in release {release_link}. Replacements: {release_name}, {release_tag}.'
+    labelTemplate = null
+    simpleMockOctokit = {
+      rest: {
+        issues: {
+          get: jest.fn(() => Promise.resolve({ data: { locked: false } })),
+          createComment: jest.fn(() => Promise.resolve()),
+          addLabels: jest.fn(() => Promise.resolve()),
+        },
+        repos: {
+          listReleases: jest.fn(() =>
+            Promise.resolve({
+              data: [
+                {
+                  name: 'Release Name',
+                  tag_name: 'current_tag_name',
+                  html_url: 'http://current_release',
+                },
+                {
+                  tag_name: 'prior_tag_name',
+                  html_url: 'http://prior_release',
+                },
+              ],
+            }),
+          ),
+          compareCommits: jest.fn(() =>
+            Promise.resolve({
+              data: { commits: [{ sha: 'SHA1' }] },
+            }),
+          ),
+        },
+      },
+      graphql: jest.fn(() =>
+        Promise.resolve({
+          resource: {
+            messageHeadlineHTML: '',
+            messageBodyHTML:
+              '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
+            associatedPullRequests: {
+              pageInfo: { hasNextPage: false },
+              edges: [],
+            },
+          },
+        }),
+      ),
+    }
+  })
+
+  afterEach(() => {
+    expect(core.error).not.toHaveBeenCalled()
+    expect(core.warning).not.toHaveBeenCalled()
+    expect(core.setFailed).not.toHaveBeenCalled()
+  })
+
+  test('main test', async () => {
+    mockOctokit = {
+      ...simpleMockOctokit,
+      rest: {
+        issues: {
+          get: jest.fn(() => Promise.resolve({ data: { locked: false } })),
+          createComment: jest.fn(() => Promise.resolve()),
+          addLabels: jest.fn(() => Promise.resolve()),
+        },
+        repos: {
+          listReleases: jest.fn(() =>
+            Promise.resolve({
+              data: [
+                {
+                  tag_name: 'current_tag_name',
+                  html_url: 'http://current_release',
+                },
+                {
+                  tag_name: 'prior_tag_name',
+                  html_url: 'http://prior_release',
+                },
+              ],
+            }),
+          ),
+          compareCommits: jest.fn(() =>
+            Promise.resolve({
+              data: { commits: [{ sha: 'SHA1' }, { sha: 'SHA2' }] },
+            }),
+          ),
+        },
+      },
+      graphql: jest.fn(() =>
+        Promise.resolve({
+          resource: {
+            messageHeadlineHTML:
+              '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #3.">Closes</span> <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="718013420" data-permission-text="Title is private" data-url="https://github.com/apexskier/github-release-commenter/issues/1" data-hovercard-type="issue" data-hovercard-url="/apexskier/github-release-commenter/issues/1/hovercard" href="https://github.com/apexskier/github-release-commenter/issues/1">#1</a>',
+            messageBodyHTML:
+              '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
+            associatedPullRequests: {
+              pageInfo: { hasNextPage: false },
+              edges: [
+                {
+                  node: {
+                    bodyHTML:
+                      '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #4.">Closes</span> <span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #5.">Closes</span>',
+                    number: 9,
+                    labels: {
+                      pageInfo: { hasNextPage: false },
+                      nodes: [{ name: 'label1' }, { name: 'label2' }],
+                    },
+                    timelineItems: {
+                      pageInfo: { hasNextPage: false },
+                      nodes: [
+                        {
+                          isCrossRepository: true,
+                          __typename: 'ConnectedEvent',
+                          subject: { number: 1 },
+                        },
+                        {
+                          isCrossRepository: false,
+                          __typename: 'ConnectedEvent',
+                          subject: { number: 2 },
+                        },
+                        {
+                          isCrossRepository: false,
+                          __typename: 'DisconnectedEvent',
+                          subject: { number: 2 },
+                        },
+                        {
+                          isCrossRepository: false,
+                          __typename: 'ConnectedEvent',
+                          subject: { number: 2 },
+                        },
+                      ],
+                    },
+                  },
+                },
+                {
+                  node: {
+                    bodyHTML: '',
+                    number: 42,
+                    labels: {
+                      pageInfo: { hasNextPage: false },
+                      nodes: [{ name: 'label1' }, { name: 'skip' }],
+                    },
+                    timelineItems: {
+                      pageInfo: { hasNextPage: false },
+                      nodes: [
+                        {
+                          isCrossRepository: true,
+                          __typename: 'ConnectedEvent',
+                          subject: { number: 82 },
+                        },
+                      ],
+                    },
+                  },
+                },
+              ],
+            },
+          },
+        }),
+      ),
+    }
+
+    jest.isolateModules(() => {
+      require('./index')
+    })
+
+    await new Promise<void>(setImmediate)
+
+    expect(mockOctokit).toMatchSnapshot()
+    expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledTimes(3)
+  })
+
+  describe('can filter tags', () => {
+    const v3prev = 'v3.0.1'
+    const v3current = 'v3.0.2'
+    const v2prev = 'v2.0.1'
+    const v2current = 'v2.0.2'
+
+    const listReleasesData = [
+      {
+        name: 'Current Release Name',
+        tag_name: v3current,
+        html_url: 'http://v3.0.2',
+      },
+      {
+        name: 'Prev Release Name',
+        tag_name: v3prev,
+        html_url: 'http://v3.0.1',
+      },
+      {
+        name: 'v2 Current Release Name',
+        tag_name: v2current,
+        html_url: 'http://v2.0.2',
+      },
+      {
+        name: 'v2 Prev Release Name',
+        tag_name: v2prev,
+        html_url: 'http://v2.0.1',
+      },
+    ]
+
+    it.each`
+      description    | prevTag   | currentTag   | filter
+      ${'no filter'} | ${v3prev} | ${v3current} | ${null}
+      ${'v3'}        | ${v3prev} | ${v3current} | ${'v\\d'}
+      ${'v2'}        | ${v2prev} | ${v2current} | ${'v\\d'}
+    `('should filter tags with $description', async ({ prevTag, currentTag, filter }) => {
+      // @ts-ignore
+      github.context.payload.release.tag_name = currentTag
+
+      tagFilter = filter
+
+      mockOctokit = {
+        ...simpleMockOctokit,
+        rest: {
+          issues: {
+            get: jest.fn(() => Promise.resolve({ data: { locked: false } })),
+            createComment: jest.fn(() => Promise.resolve()),
+            addLabels: jest.fn(() => Promise.resolve()),
+          },
+          repos: {
+            listReleases: jest.fn(() =>
+              Promise.resolve({
+                data: listReleasesData,
+              }),
+            ),
+            compareCommits: jest.fn(() =>
+              Promise.resolve({
+                data: { commits: [{ sha: 'SHA1' }] },
+              }),
+            ),
+          },
+        },
+        graphql: jest.fn(() =>
+          Promise.resolve({
+            resource: {
+              messageHeadlineHTML: '',
+              messageBodyHTML:
+                '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
+              associatedPullRequests: {
+                pageInfo: { hasNextPage: false },
+                edges: [],
+              },
+            },
+          }),
+        ),
+      }
+
+      jest.isolateModules(() => {
+        require('./index')
+      })
+
+      await new Promise<void>(resolve => setImmediate(() => resolve()))
+
+      expect(github.getOctokit).toHaveBeenCalled()
+      expect(mockOctokit.rest.repos.compareCommits.mock.calls).toEqual([
+        [{ base: prevTag, head: currentTag }],
+      ])
+    })
+  })
+
+  describe('feature tests', () => {
+    beforeEach(() => {
+      mockOctokit = simpleMockOctokit
+    })
+
+    it('can disable comments', async () => {
+      commentTempate = ''
+
+      jest.isolateModules(() => {
+        require('./index')
+      })
+
+      await new Promise<void>(resolve => setImmediate(() => resolve()))
+
+      expect(github.getOctokit).toHaveBeenCalled()
+      expect(mockOctokit.rest.issues.createComment).not.toHaveBeenCalled()
+    })
+
+    it('should unlock and comment', async () => {
+      mockOctokit = {
+        ...simpleMockOctokit,
+        rest: {
+          ...simpleMockOctokit.rest,
+          issues: {
+            // Return locked for both issues to be commented on
+            get: jest.fn(() => Promise.resolve({ data: { locked: true } })),
+            lock: jest.fn(() => Promise.resolve()),
+            unlock: jest.fn(() => Promise.resolve()),
+            createComment: jest.fn(() => Promise.resolve()),
+          },
+        },
+        graphql: jest.fn(() =>
+          Promise.resolve({
+            resource: {
+              messageHeadlineHTML: '',
+              messageBodyHTML:
+                '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
+              associatedPullRequests: {
+                pageInfo: { hasNextPage: false },
+                edges: [],
+              },
+            },
+          }),
+        ),
+      }
+
+      jest.isolateModules(() => {
+        require('./index')
+      })
+
+      await new Promise<void>(resolve => setImmediate(() => resolve()))
+
+      expect(github.getOctokit).toHaveBeenCalled()
+
+      // Should call once for both linked issues
+      expect(mockOctokit.rest.issues.unlock).toHaveBeenCalledTimes(2)
+      expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledTimes(2)
+      expect(mockOctokit.rest.issues.lock).toHaveBeenCalledTimes(2)
+    })
+
+    it.skip('can apply labels', async () => {
+      labelTemplate = ':dart: landed,release-{release_tag},{release_name}'
+
+      jest.isolateModules(() => {
+        require('./index')
+      })
+
+      await new Promise<void>(resolve => setImmediate(() => resolve()))
+
+      expect(github.getOctokit).toHaveBeenCalled()
+      expect(mockOctokit.rest.issues.addLabels.mock.calls).toMatchSnapshot()
+    })
+  })
+})

.github/actions/release-commenter/src/index.ts

@@ -0,0 +1,349 @@
+import * as core from '@actions/core'
+import * as github from '@actions/github'
+import type * as Webhooks from '@octokit/webhooks-types'
+
+const closesMatcher = /aria-label="This (?:commit|pull request) closes issue #(\d+)\."/g
+
+const releaseLinkTemplateRegex = /{release_link}/g
+const releaseNameTemplateRegex = /{release_name}/g
+const releaseTagTemplateRegex = /{release_tag}/g
+
+;(async function main() {
+  try {
+    const payload = github.context.payload as Webhooks.EventPayloadMap['release']
+
+    const githubToken = core.getInput('GITHUB_TOKEN')
+    const tagFilter = core.getInput('tag-filter') || undefined // Accept tag filter as an input
+    const octokit = github.getOctokit(githubToken)
+
+    const commentTemplate = core.getInput('comment-template')
+    const labelTemplate = core.getInput('label-template') || null
+    const skipLabelTemplate = core.getInput('skip-label') || null
+
+    // Fetch the releases with the optional tag filter applied
+    const { data: rawReleases } = await octokit.rest.repos.listReleases({
+      ...github.context.repo,
+      per_page: 100,
+    })
+
+    // Get the current release tag or latest tag
+    const currentTag = payload?.release?.tag_name || rawReleases?.[0]?.tag_name
+
+    let releases = rawReleases
+
+    // Filter releases by the tag filter if provided
+    if (tagFilter) {
+      core.info(`Filtering releases by tag filter: ${tagFilter}`)
+      // Get the matching part of the current release tag
+      const regexMatch = currentTag.match(tagFilter)?.[0]
+      if (!regexMatch) {
+        core.error(`Current release tag ${currentTag} does not match the tag filter ${tagFilter}`)
+        return
+      }
+
+      core.info(`Matched string from filter: ${regexMatch}`)
+
+      releases = releases
+        .filter(release => {
+          const match = release.tag_name.match(regexMatch)?.[0]
+          return match
+        })
+        .slice(0, 2)
+    }
+
+    core.info(`Releases: ${JSON.stringify(releases, null, 2)}`)
+
+    if (releases.length < 2) {
+      if (!releases.length) {
+        core.error(`No releases found with the provided tag filter: '${tagFilter}'`)
+        return
+      }
+
+      core.info('first release')
+      return
+    }
+
+    const [currentRelease, priorRelease] = releases
+
+    core.info(`${priorRelease.tag_name}...${currentRelease.tag_name}`)
+
+    const {
+      data: { commits },
+    } = await octokit.rest.repos.compareCommits({
+      ...github.context.repo,
+      base: priorRelease.tag_name,
+      head: currentRelease.tag_name,
+    })
+
+    if (!currentRelease.name) {
+      core.info('Current release has no name, will fall back to the tag name.')
+    }
+    const releaseLabel = currentRelease.name || currentRelease.tag_name
+
+    const comment = commentTemplate
+      .trim()
+      .split(releaseLinkTemplateRegex)
+      .join(`[${releaseLabel}](${currentRelease.html_url})`)
+      .split(releaseNameTemplateRegex)
+      .join(releaseLabel)
+      .split(releaseTagTemplateRegex)
+      .join(currentRelease.tag_name)
+
+    const parseLabels = (rawInput: string | null) =>
+      rawInput
+        ?.split(releaseNameTemplateRegex)
+        .join(releaseLabel)
+        ?.split(releaseTagTemplateRegex)
+        .join(currentRelease.tag_name)
+        ?.split(',')
+        ?.map(l => l.trim())
+        .filter(l => l)
+
+    const labels = parseLabels(labelTemplate)
+    const skipLabels = parseLabels(skipLabelTemplate)
+
+    const linkedIssuesPrs = new Set<number>()
+
+    await Promise.all(
+      commits.map(commit =>
+        (async () => {
+          const query = `
+            {
+              resource(url: "${payload.repository.html_url}/commit/${commit.sha}") {
+                ... on Commit {
+                  messageHeadlineHTML
+                  messageBodyHTML
+                  associatedPullRequests(first: 10) {
+                    pageInfo {
+                      hasNextPage
+                    }
+                    edges {
+                      node {
+                        bodyHTML
+                        number
+                        state
+                        labels(first: 10) {
+                          pageInfo {
+                            hasNextPage
+                          }
+                          nodes {
+                            name
+                          }
+                        }
+                        timelineItems(itemTypes: [CONNECTED_EVENT, DISCONNECTED_EVENT], first: 100) {
+                          pageInfo {
+                            hasNextPage
+                          }
+                          nodes {
+                            ... on ConnectedEvent {
+                              __typename
+                              isCrossRepository
+                              subject {
+                                ... on Issue {
+                                  number
+                                }
+                              }
+                            }
+                            ... on DisconnectedEvent {
+                              __typename
+                              isCrossRepository
+                              subject {
+                                ... on Issue {
+                                  number
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          `
+          const response: {
+            resource: null | {
+              messageHeadlineHTML: string
+              messageBodyHTML: string
+              associatedPullRequests: {
+                pageInfo: { hasNextPage: boolean }
+                edges: ReadonlyArray<{
+                  node: {
+                    bodyHTML: string
+                    number: number
+                    state: 'OPEN' | 'CLOSED' | 'MERGED'
+                    labels: {
+                      pageInfo: { hasNextPage: boolean }
+                      nodes: ReadonlyArray<{
+                        name: string
+                      }>
+                    }
+                    timelineItems: {
+                      pageInfo: { hasNextPage: boolean }
+                      nodes: ReadonlyArray<{
+                        __typename: 'ConnectedEvent' | 'DisconnectedEvent'
+                        isCrossRepository: boolean
+                        subject: {
+                          number: number
+                        }
+                      }>
+                    }
+                  }
+                }>
+              }
+            }
+          } = await octokit.graphql(query)
+
+          if (!response.resource) {
+            return
+          }
+
+          // core.info(JSON.stringify(response.resource, null, 2))
+
+          core.info(`Checking commit: ${payload.repository.html_url}/commit/${commit.sha}`)
+
+          const associatedClosedPREdges = response.resource.associatedPullRequests.edges.filter(
+            e => e.node.state === 'MERGED',
+          )
+
+          if (associatedClosedPREdges.length) {
+            core.info(
+              `  Associated Merged PRs:\n    ${associatedClosedPREdges.map(pr => `${payload.repository.html_url}/pull/${pr.node.number}`).join('\n    ')}`,
+            )
+          } else {
+            core.info('  No associated merged PRs')
+          }
+
+          const html = [
+            response.resource.messageHeadlineHTML,
+            response.resource.messageBodyHTML,
+            ...associatedClosedPREdges.map(pr => pr.node.bodyHTML),
+          ].join(' ')
+
+          for (const match of html.matchAll(closesMatcher)) {
+            const [, num] = match
+            linkedIssuesPrs.add(parseInt(num, 10))
+            core.info(
+              `  Linked issue/PR from closesMatcher: ${payload.repository.html_url}/pull/${num}`,
+            )
+          }
+
+          if (response.resource.associatedPullRequests.pageInfo.hasNextPage) {
+            core.warning(`Too many PRs associated with ${commit.sha}`)
+          }
+
+          const seen = new Set<number>()
+          for (const associatedPR of associatedClosedPREdges) {
+            if (associatedPR.node.timelineItems.pageInfo.hasNextPage) {
+              core.warning(`Too many links for #${associatedPR.node.number}`)
+            }
+            if (associatedPR.node.labels.pageInfo.hasNextPage) {
+              core.warning(`Too many labels for #${associatedPR.node.number}`)
+            }
+            // a skip labels is present on this PR
+            if (
+              skipLabels?.some(l => associatedPR.node.labels.nodes.some(({ name }) => name === l))
+            ) {
+              continue
+            }
+
+            linkedIssuesPrs.add(associatedPR.node.number)
+            core.info(
+              `  Linked issue/PR from associated PR: ${payload.repository.html_url}/pull/${associatedPR.node.number}`,
+            )
+
+            // These are sorted by creation date in ascending order. The latest event for a given issue/PR is all we need
+            // ignore links that aren't part of this repo
+            const links = associatedPR.node.timelineItems.nodes
+              .filter(node => !node.isCrossRepository)
+              .reverse()
+            for (const link of links) {
+              if (seen.has(link.subject.number)) {
+                continue
+              }
+              if (link.__typename == 'ConnectedEvent') {
+                linkedIssuesPrs.add(link.subject.number)
+                core.info(
+                  `Linked issue/PR from connected event: ${payload.repository.html_url}/pull/${link.subject.number}`,
+                )
+              }
+              seen.add(link.subject.number)
+            }
+          }
+        })(),
+      ),
+    )
+
+    core.info(
+      `Final issues/PRs to be commented on: \n${Array.from(linkedIssuesPrs)
+        .map(num => `  ${payload.repository.html_url}/pull/${num}`)
+        .join('\n')}`,
+    )
+
+    const requests: Array<Promise<unknown>> = []
+    for (const issueNumber of linkedIssuesPrs) {
+      const baseRequest = {
+        ...github.context.repo,
+        issue_number: issueNumber,
+      }
+      if (comment) {
+        const commentRequest = {
+          ...baseRequest,
+          body: comment,
+        }
+
+        // Check if issue is locked or not
+        const { data: issue } = await octokit.rest.issues.get(baseRequest)
+
+        let createCommentPromise: () => Promise<void>
+        if (!issue.locked) {
+          createCommentPromise = async () => {
+            try {
+              await octokit.rest.issues.createComment(commentRequest)
+            } catch (error) {
+              core.error(error as Error)
+              core.error(
+                `Failed to comment on issue/PR: ${issueNumber}. ${payload.repository.html_url}/pull/${issueNumber}`,
+              )
+            }
+          }
+        } else {
+          core.info(
+            `Issue/PR is locked: ${issueNumber}. Unlocking, commenting, and re-locking. ${payload.repository.html_url}/pull/${issueNumber}`,
+          )
+          createCommentPromise = async () => {
+            try {
+              core.debug(`Unlocking issue/PR: ${issueNumber}`)
+              await octokit.rest.issues.unlock(baseRequest)
+              core.debug(`Commenting on issue/PR: ${issueNumber}`)
+              await octokit.rest.issues.createComment(commentRequest)
+              core.debug(`Re-locking issue/PR: ${issueNumber}`)
+              await octokit.rest.issues.lock(baseRequest)
+            } catch (error) {
+              core.error(error as Error)
+              core.error(
+                `Failed to unlock, comment, and re-lock issue/PR: ${issueNumber}. ${payload.repository.html_url}/pull/${issueNumber}`,
+              )
+            }
+          }
+        }
+
+        requests.push(createCommentPromise())
+      }
+      if (labels) {
+        const request = {
+          ...baseRequest,
+          labels,
+        }
+        // core.info(JSON.stringify(request, null, 2))
+        requests.push(octokit.rest.issues.addLabels(request))
+      }
+    }
+
+    await Promise.all(requests)
+  } catch (error) {
+    core.error(error as Error)
+    core.setFailed((error as Error).message)
+  }
+})()

.github/actions/release-commenter/tsconfig.json

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

.github/actions/triage/.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/eslint-recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+}

.github/actions/triage/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  printWidth: 100,
+  parser: 'typescript',
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+  arrowParens: 'avoid',
+}

.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'
+  tag-only:
+    description: Log and tag only. Do not perform closing or commenting actions.
+    default: false
+
+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_TAG_ONLY": ${{inputs.tag-only}}

.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",
+  "description": "GitHub Action to triage new issues",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "private": true,
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "pnpm build:typecheck && pnpm build:ncc",
+    "build:ncc": "ncc build src/index.ts -t -o dist",
+    "build:typecheck": "tsc",
+    "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,195 @@
+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')
+
+// Define the configuration object
+interface Config {
+  invalidLink: {
+    comment: string
+    bugLabels: string[]
+    hosts: string[]
+    label: string
+    linkSection: string
+  }
+  tagOnly: boolean
+  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',
+  },
+  tagOnly: getBooleanOrUndefined('tag_only') || false,
+  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 })),
+  )
+  info(`Issue #${issue.number} - validate label removed`)
+  await client.issues.addLabels({ ...common, labels: [config.invalidLink.label] })
+  info(`Issue #${issue.number} - labeled`)
+
+  // If tagOnly, do not close or comment
+  if (config.tagOnly) {
+    info('Tag-only enabled, no closing/commenting actions taken')
+    return
+  }
+
+  // Perform closing and commenting actions
+  await client.issues.update({ ...common, state: 'closed' })
+  info(`Issue #${issue.number} - closed`)
+
+  const comment = join(config.workspace, config.invalidLink.comment)
+  await client.issues.createComment({ ...common, body: await getCommentBody(comment) })
+  info(`Issue #${issue.number} - commented`)
+}
+
+/**
+ * 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,18 @@
+We cannot recreate the issue with the provided information. **Please add a reproduction in order for us to be able to investigate.**
+
+### 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-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - 'actions/*'

.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

@@ -27,7 +27,7 @@ jobs:
         with:
           filters: |
             needs_build:
-              - '.github/workflows/**'
+              - '.github/workflows/main.yml'
               - 'packages/**'
               - 'test/**'
               - 'pnpm-lock.yaml'
@@ -61,7 +61,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 8
+          version: 9.7.0
           run_install: false
 
       - name: Get pnpm store directory
@@ -116,7 +116,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 8
+          version: 9.7.0
           run_install: false
 
       - name: Restore build
@@ -201,7 +201,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 8
+          version: 9.7.0
           run_install: false
 
       - name: Restore build
@@ -242,7 +242,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 8
+          version: 9.7.0
           run_install: false
 
       - name: Restore build
@@ -286,7 +286,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 8
+          version: 9.7.0
           run_install: false
 
       - name: Restore build
@@ -327,7 +327,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 8
+          version: 9.7.0
           run_install: false
 
       - name: Restore build

.github/workflows/post-release.yml

@@ -0,0 +1,32 @@
+name: post-release
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  post_release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          # Only needed if debugging on a branch other than default
+          # ref: ${{ github.event.release.target_commitish || github.ref }}
+      - run: echo "npm_version=$(npm pkg get version | tr -d '"')" >> "$GITHUB_ENV"
+      - uses: ./.github/actions/release-commenter
+        continue-on-error: true
+        env:
+          ACTIONS_STEP_DEBUG: true
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag-filter: 'v\d'
+
+
+          # Change to blank to disable commenting
+          # comment-template: ''
+
+          comment-template: |
+            🚀 This is included in version {release_link}

.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'
+          tag-only: 'true'

.gitignore

@@ -4,6 +4,9 @@ dist
 /.idea/*
 !/.idea/runConfigurations
 
+# Custom actions
+!.github/actions/**/dist
+
 test-results
 .devcontainer
 .localstack
@@ -134,7 +137,6 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
-dist
 
 # Gatsby files
 .cache/

.vscode/launch.json

@@ -54,6 +54,13 @@
       "request": "launch",
       "type": "node-terminal"
     },
+    {
+      "command": "pnpm run dev field-error-states",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Field Error States",
+      "request": "launch",
+      "type": "node-terminal"
+    },
     {
       "command": "pnpm run dev uploads",
       "cwd": "${workspaceFolder}",

.vscode/settings.json

@@ -35,5 +35,9 @@
   "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }],
   "typescript.tsdk": "node_modules/typescript/lib",
   // Load .git-blame-ignore-revs file
-  "gitlens.advanced.blame.customArguments": ["--ignore-revs-file", ".git-blame-ignore-revs"]
+  "gitlens.advanced.blame.customArguments": ["--ignore-revs-file", ".git-blame-ignore-revs"],
+  "jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--experimental-vm-modules --no-deprecation\" node 'node_modules/jest/bin/jest.js'",
+  "jestrunner.debugOptions": {
+    "runtimeArgs": ["--experimental-vm-modules", "--no-deprecation"]
+  }
 }

CHANGELOG.md

@@ -1,3 +1,298 @@
+## [2.30.4](https://github.com/payloadcms/payload/compare/v2.30.3...v2.30.4) (2024-11-11)
+
+
+### Features
+
+* **plugin-seo:** add Turkish translation ([#8918](https://github.com/payloadcms/payload/issues/8918)) ([7c9ec9c](https://github.com/payloadcms/payload/commit/7c9ec9c4e0bafd19eb0ef94e9bb4aa07df3e097e))
+
+
+### Bug Fixes
+
+* **db-postgres:** sort by localized fields ([#9016](https://github.com/payloadcms/payload/issues/9016)) ([9c25754](https://github.com/payloadcms/payload/commit/9c25754eed87e70b053231693102378150b8b80d))
+* edit many modal draft action button order and style ([#9046](https://github.com/payloadcms/payload/issues/9046)) ([a907480](https://github.com/payloadcms/payload/commit/a907480a94f07b4afa0e0723a3738c8bd457c51f)), closes [#9045](https://github.com/payloadcms/payload/issues/9045)
+* error saving after duplicating blocks with nested items ([#8814](https://github.com/payloadcms/payload/issues/8814)) ([eba777c](https://github.com/payloadcms/payload/commit/eba777c3a0b4c489d87d3c6154d835a105fef4a2))
+* list drawer relationship not displaying ([#9011](https://github.com/payloadcms/payload/issues/9011)) ([169da5c](https://github.com/payloadcms/payload/commit/169da5c3d83bfe3559227504929aa62721ded1d9))
+* querying relationships by `id` path with REST ([#9014](https://github.com/payloadcms/payload/issues/9014)) ([a0bd706](https://github.com/payloadcms/payload/commit/a0bd7060c45df3037ee074bd83400837c0adb83a))
+
+## [2.30.3](https://github.com/payloadcms/payload/compare/v2.30.2...v2.30.3) (2024-10-18)
+
+
+### Bug Fixes
+
+* **db-postgres:** migrate:create errors with previous schemas ([#8786](https://github.com/payloadcms/payload/issues/8786)) ([e9c1222](https://github.com/payloadcms/payload/commit/e9c12221824a9a180991722135d22ff91d07ef11))
+* duplicate with select hasMany fields ([#8734](https://github.com/payloadcms/payload/issues/8734)) ([c8ed645](https://github.com/payloadcms/payload/commit/c8ed6454a733bea09ae620517c4894701999e119))
+
+## [2.30.2](https://github.com/payloadcms/payload/compare/v2.30.1...v2.30.2) (2024-10-17)
+
+### Bug Fixes
+
+* applies resize after cropping if `resizeOptions` are defined ([#8535](https://github.com/payloadcms/payload/issues/8535)) ([f2284f3](https://github.com/payloadcms/payload/commit/f2284f3d1b420c543d9eee9929f961db4cbef8a1))
+* calculates correct aspect ratio dimensions on sharp based files ([#8510](https://github.com/payloadcms/payload/issues/8510)) ([9d05b82](https://github.com/payloadcms/payload/commit/9d05b82dc67b967e55176b92f7b20d4486883201)), closes [#8317](https://github.com/payloadcms/payload/issues/8317)
+* **db-postgres:** build indexes for relationships ([#8446](https://github.com/payloadcms/payload/issues/8446)) ([d05e3b0](https://github.com/payloadcms/payload/commit/d05e3b0411c2e705bd7a26e93ba55f2b7532e41b))
+* **db-postgres:** port many various fixes from 3.0 ([#8468](https://github.com/payloadcms/payload/issues/8468)) ([1347b6c](https://github.com/payloadcms/payload/commit/1347b6cc36c33043755b4e31d7731ba19b8c985f))
+* **db-postgres:** select hasMany nested to array + tab/group ([#8739](https://github.com/payloadcms/payload/issues/8739)) ([0efc610](https://github.com/payloadcms/payload/commit/0efc6102104729a162912157a7e34293ec9764a5))
+* **richtext-lexical:** add target _blank for new-tab in linkFeature ([#8571](https://github.com/payloadcms/payload/issues/8571)) ([61e8ce1](https://github.com/payloadcms/payload/commit/61e8ce17439301cb16aee92887e97a69cac4e044)), closes [#8569](https://github.com/payloadcms/payload/issues/8569)
+
+## [2.30.1](https://github.com/payloadcms/payload/compare/v2.30.0...v2.30.1) (2024-10-02)
+
+
+### Bug Fixes
+
+* **db-mongodb:** properly filters out `number` field values with the `exists` operator filter ([#8415](https://github.com/payloadcms/payload/issues/8415)) ([0586f23](https://github.com/payloadcms/payload/commit/0586f236bbf04163a0d9b226772849cb3d977864)), closes [#8181](https://github.com/payloadcms/payload/issues/8181)
+* sorting by id incorrectly orders by version.id ([#8450](https://github.com/payloadcms/payload/issues/8450)) ([1d38e6d](https://github.com/payloadcms/payload/commit/1d38e6d5d5b56a91aa8f59a461d40f28b1750f8c))
+
+## [2.30.0](https://github.com/payloadcms/payload/compare/v2.29.0...v2.30.0) (2024-09-27)
+
+* export toast from react toastify in payload ([#8438](https://github.com/payloadcms/payload/issues/8438)) ([17fc2d1](https://github.com/payloadcms/payload/commit/17fc2d13d06b6de01f839c27fd706bc0d6a185eb))
+
+## [2.29.0](https://github.com/payloadcms/payload/compare/v2.28.0...v2.29.0) (2024-09-25)
+
+
+### Features
+
+* add new option to disable JOI validation ([#8067](https://github.com/payloadcms/payload/issues/8067)) ([28a0650](https://github.com/payloadcms/payload/commit/28a065072fcad2dc768e44d79609eb5ab8a3fdfd))
+
+
+### Bug Fixes
+
+* **db-postgres:** localized items in arrays with versions ([#8334](https://github.com/payloadcms/payload/issues/8334)) ([c86526b](https://github.com/payloadcms/payload/commit/c86526b5c81ff484e66fbe6e7c727fdcc1f93c77))
+* **db-postgres:** querying on array within a relationship field ([#8153](https://github.com/payloadcms/payload/issues/8153)) ([170ea5b](https://github.com/payloadcms/payload/commit/170ea5badcff154514b8166ac92177d89a3fa5f8))
+* **db-postgres:** sanitize tab/group path for table name ([#8010](https://github.com/payloadcms/payload/issues/8010)) ([ba7a043](https://github.com/payloadcms/payload/commit/ba7a043a99f58fad39a62ac471eeb7309a39bba0))
+* treat empty strings as null / undefined for `exists` queries ([#8336](https://github.com/payloadcms/payload/issues/8336)) ([31d0b30](https://github.com/payloadcms/payload/commit/31d0b309fe5df1e37ed2a938959c1ef87834d987)), closes [#7714](https://github.com/payloadcms/payload/issues/7714)
+
+## [2.28.0](https://github.com/payloadcms/payload/compare/v2.27.0...v2.28.0) (2024-09-04)
+
+
+### Features
+
+* collections can use custom database operations ([#7675](https://github.com/payloadcms/payload/issues/7675)) ([6ba293c](https://github.com/payloadcms/payload/commit/6ba293c0f84f91bf89cf089a20e47de130013ebb))
+
+
+### Bug Fixes
+
+* **db-postgres:** migration exit codes ([#7873](https://github.com/payloadcms/payload/issues/7873)) ([25e9bc6](https://github.com/payloadcms/payload/commit/25e9bc62dbcbabcb3619cf83e3dc0110e0a4cabf)), closes [#7031](https://github.com/payloadcms/payload/issues/7031)
+* **db-postgres:** query hasMany text/number in array/blocks ([#8033](https://github.com/payloadcms/payload/issues/8033)) ([96a624a](https://github.com/payloadcms/payload/commit/96a624ad5c5259b197b4ca793d8419d1e827de9c))
+* **plugin-cloud:** better logging on static handler ([#7924](https://github.com/payloadcms/payload/issues/7924)) ([1f09348](https://github.com/payloadcms/payload/commit/1f0934877ce5aabb771c936c3677a26d2ef006ec))
+
+## [2.27.0](https://github.com/payloadcms/payload/compare/v2.26.0...v2.27.0) (2024-08-26)
+
+
+### Features
+
+* add support for custom image size file names ([#7637](https://github.com/payloadcms/payload/issues/7637)) ([f976270](https://github.com/payloadcms/payload/commit/f97627092cabe4eabbebefa75afc53579188386b))
+* upgrade react-toastify dependency, and upgrade to pnpm v9 in our monorepo ([#7667](https://github.com/payloadcms/payload/issues/7667)) ([94d18e8](https://github.com/payloadcms/payload/commit/94d18e8d747588efce225cde0b621db9b513e7c1))
+
+
+### Bug Fixes
+
+* update state of field if either `valid` status or `errorMessage` changes ([#7632](https://github.com/payloadcms/payload/issues/7632)) ([c624eea](https://github.com/payloadcms/payload/commit/c624eea0d868938f4603860fa25be3df580ba7fe)), closes [#6413](https://github.com/payloadcms/payload/issues/6413)
+
+## [2.26.0](https://github.com/payloadcms/payload/compare/v2.25.0...v2.26.0) (2024-08-09)
+
+
+### Features
+
+* adds classnames to edit, list views ([#7595](https://github.com/payloadcms/payload/issues/7595)) ([7f39afa](https://github.com/payloadcms/payload/commit/7f39afa1928b118451138e811ea71a04fce021d5))
+* adds upload's relationship thumbnail ([#5015](https://github.com/payloadcms/payload/issues/5015)) ([39e110e](https://github.com/payloadcms/payload/commit/39e110e6331efff0ca8ca7174780076243a016de))
+* **ui:** expose custom errors in delete many ([#7439](https://github.com/payloadcms/payload/issues/7439)) ([3e780b9](https://github.com/payloadcms/payload/commit/3e780b98155550f877021996dd094ba435dff81b))
+
+
+### Bug Fixes
+
+* **db-postgres:** localized array inside blocks field ([#7458](https://github.com/payloadcms/payload/issues/7458)) ([a308d63](https://github.com/payloadcms/payload/commit/a308d6384f9724c5ff330382070a5803fbcf167c)), closes [#5240](https://github.com/payloadcms/payload/issues/5240)
+* deprecated `inflight` package ([#6558](https://github.com/payloadcms/payload/issues/6558)) ([eca1517](https://github.com/payloadcms/payload/commit/eca1517237c78983c192f4bafa92a86d94a0de9e)), closes [#6492](https://github.com/payloadcms/payload/issues/6492)
+* enable `relationship` & `upload` field population in `versions` ([#7533](https://github.com/payloadcms/payload/issues/7533)) ([9865ae9](https://github.com/payloadcms/payload/commit/9865ae998b9aeb5d72724023976bb203133e19ff))
+* filtering by non-poly `relationships` with `not_equals` operator ([#7573](https://github.com/payloadcms/payload/issues/7573)) ([efa56ce](https://github.com/payloadcms/payload/commit/efa56cefc15a48cd45b3aaba2eddacca79e1be30)), closes [#5212](https://github.com/payloadcms/payload/issues/5212) [#6278](https://github.com/payloadcms/payload/issues/6278)
+* filtering by polymorphic `relationships` with `drafts` enabled ([#7565](https://github.com/payloadcms/payload/issues/7565)) ([907d7d1](https://github.com/payloadcms/payload/commit/907d7d1d3a89ed22bb991a1f238bb77d54e3e173)), closes [#6880](https://github.com/payloadcms/payload/issues/6880)
+* retained date milliseconds ([#7393](https://github.com/payloadcms/payload/issues/7393)) ([9c9e689](https://github.com/payloadcms/payload/commit/9c9e6896a502de209c6cccf63cc5cfc0f0143bf3)), closes [#6108](https://github.com/payloadcms/payload/issues/6108)
+* prevents `hasMany` text going outside of input boundaries ([#7454](https://github.com/payloadcms/payload/issues/7454)) ([1a0ef48](https://github.com/payloadcms/payload/commit/1a0ef4824b3d6548d36e7f28a2030640361c0655)), closes [#6034](https://github.com/payloadcms/payload/issues/6034)
+* previousValue missing from ValidateOptions type ([#6931](https://github.com/payloadcms/payload/issues/6931)) ([fca5a40](https://github.com/payloadcms/payload/commit/fca5a404dbf3b440b428e55cf5e03db647f9a453))
+* render singular label for `ArrayCell` when length is 1 ([#7585](https://github.com/payloadcms/payload/issues/7585)) ([fc4d24a](https://github.com/payloadcms/payload/commit/fc4d24aa8889ac9be76059a92478d5532b142b5c)), closes [#6099](https://github.com/payloadcms/payload/issues/6099)
+
+## [2.25.0](https://github.com/payloadcms/payload/compare/v2.24.2...v2.25.0) (2024-07-26)
+
+
+### Features
+
+* allows metadata to be appended to the file of the output media ([#7295](https://github.com/payloadcms/payload/issues/7295)) ([3c5cce4](https://github.com/payloadcms/payload/commit/3c5cce4c6f108f87e87b091bbfec976423de73a2))
+* **db-mongodb:** adds new optional `collation` feature flag behind mongodb collation option ([#7359](https://github.com/payloadcms/payload/issues/7359)) ([9750bc2](https://github.com/payloadcms/payload/commit/9750bc217ee7d63732a34908c84eb88b88dac0a8)), closes [#7349](https://github.com/payloadcms/payload/issues/7349)
+
+
+### Bug Fixes
+
+* properly handles `0` value number fields in list view ([#7364](https://github.com/payloadcms/payload/issues/7364)) ([5321098](https://github.com/payloadcms/payload/commit/5321098d7eada43838f6d5c69f3233c150fe0afa)), closes [#5510](https://github.com/payloadcms/payload/issues/5510)
+* preserves objectids in deepCopyObject ([#7385](https://github.com/payloadcms/payload/issues/7385)) ([1348483](https://github.com/payloadcms/payload/commit/134848364801c72cc773ef7b48854306d1b9bac3))
+* relaxes equality check for relationship options in filter ([#7344](https://github.com/payloadcms/payload/issues/7344)) ([468e544](https://github.com/payloadcms/payload/commit/468e5441f16775134d915ec7caddb17b817d3408))
+* supports null values in query strings ([#5241](https://github.com/payloadcms/payload/issues/5241)) ([c57591b](https://github.com/payloadcms/payload/commit/c57591bc4fb8d28b7de16a111faffea7d3e11f8d))
+
+## [2.24.2](https://github.com/payloadcms/payload/compare/v2.24.1...v2.24.2) (2024-07-24)
+
+
+### Features
+
+* **db-mongodb:** add jsonParse flag to mongooseAdapter that preserves existing, untracked MongoDB data types ([#7338](https://github.com/payloadcms/payload/issues/7338)) ([f96cf59](https://github.com/payloadcms/payload/commit/f96cf593cedcae0d8ed55f9a70e8e4e77917a876))
+
+
+### Bug Fixes
+
+* allow autosave relationship drawers to function properly ([#7325](https://github.com/payloadcms/payload/issues/7325)) ([69e7b7a](https://github.com/payloadcms/payload/commit/69e7b7a158c38058ece54a97bfa79e65192774a6))
+* **db-mongodb:** removes precedence of regular chars over international chars in sort ([#6923](https://github.com/payloadcms/payload/issues/6923)) ([0058660](https://github.com/payloadcms/payload/commit/0058660b3f8bd820abb4494ff53fa67f49f0f6b4)), closes [#6719](https://github.com/payloadcms/payload/issues/6719)
+* fetches and sets permissions before setting user ([#7337](https://github.com/payloadcms/payload/issues/7337)) ([8259611](https://github.com/payloadcms/payload/commit/8259611ce60e23f6298a07564d5f6dd2966d61ff))
+* **plugin-stripe:** properly types async webhooks ([#7316](https://github.com/payloadcms/payload/issues/7316)) ([c6da99b](https://github.com/payloadcms/payload/commit/c6da99b4d1b986089bb697486a7825db66323078))
+
+## [2.24.1](https://github.com/payloadcms/payload/compare/v2.24.0...v2.24.1) (2024-07-22)
+
+
+### Bug Fixes
+
+* aliases AfterMe, AfterLogout, and AfterRefresh hook types ([#7146](https://github.com/payloadcms/payload/issues/7146)) ([20377bb](https://github.com/payloadcms/payload/commit/20377bb22c867552e412c1cafd16869399aadd68))
+* exports fallback hook types to ensure backwards compatibility ([#7217](https://github.com/payloadcms/payload/issues/7217)) ([1864577](https://github.com/payloadcms/payload/commit/18645771c86664f1246f0fb599c8265a4cd1d6c0))
+* resizes images first before applying focal point ([#7278](https://github.com/payloadcms/payload/issues/7278)) ([1b208c7](https://github.com/payloadcms/payload/commit/1b208c7addf56ae8a1af5e408b001b3e5f080a38))
+* uploads from drawer and focal point positioning ([#7244](https://github.com/payloadcms/payload/issues/7244)) ([0841d5a](https://github.com/payloadcms/payload/commit/0841d5a35ee00650c703231a08fc9a361861ba67))
+
+## [2.24.0](https://github.com/payloadcms/payload/compare/v2.23.1...v2.24.0) (2024-07-16)
+
+
+### Features
+
+* adds ability to upload files from a remote url ([#7087](https://github.com/payloadcms/payload/issues/7087)) ([84d214f](https://github.com/payloadcms/payload/commit/84d214f99207ad78a466b8c16eb36e29f57cd0e3))
+* **db-mongodb:** allows mongoose schemaOptions to be configured ([#7099](https://github.com/payloadcms/payload/issues/7099)) ([51474fa](https://github.com/payloadcms/payload/commit/51474fa661ae24ab8fc0d13001fafc0f35216c1e))
+
+
+### Bug Fixes
+
+* ensures access query runs with locale when present ([#6981](https://github.com/payloadcms/payload/issues/6981)) ([a5492af](https://github.com/payloadcms/payload/commit/a5492afad672e19dd35b1f5370b51f22656f334c))
+
+## [2.23.1](https://github.com/payloadcms/payload/compare/v2.23.0...v2.23.1) (2024-06-28)
+
+### Bug Fixes
+
+* remove unused refresh arg, this affected me/refresh hooks ([#6976](https://github.com/payloadcms/payload/issues/6976)) ([c82d2ca](https://github.com/payloadcms/payload/commit/77e8ce980ef0bcb0380b499dd1ccdfd36199b707))
+
+## [2.23.0](https://github.com/payloadcms/payload/compare/v2.22.2...v2.23.0) (2024-06-28)
+
+
+### Features
+
+* adds me and refresh hooks ([#6968](https://github.com/payloadcms/payload/issues/6968)) ([c82d2ca](https://github.com/payloadcms/payload/commit/c82d2caa29422083e97affc99a033296d78892d6))
+
+
+### Bug Fixes
+
+* **richtext-lexical:** html converters unnecessarily growing over time ([#6963](https://github.com/payloadcms/payload/issues/6963)) ([cf52d64](https://github.com/payloadcms/payload/commit/cf52d64d984d98ab782ca33f20b43c935ce60683))
+
+## [2.22.2](https://github.com/payloadcms/payload/compare/v2.22.1...v2.22.2) (2024-06-26)
+
+
+### Bug Fixes
+
+* return exp and strategy from auth ([#6943](https://github.com/payloadcms/payload/issues/6943)) ([ea18735](https://github.com/payloadcms/payload/commit/ea18735d3b2d2a96989009130e3724aab487e520))
+
+## [2.22.1](https://github.com/payloadcms/payload/compare/v2.22.0...v2.22.1) (2024-06-25)
+
+
+### Bug Fixes
+
+* graphql query concurrency issues ([#6857](https://github.com/payloadcms/payload/issues/6857)) ([bb911cc](https://github.com/payloadcms/payload/commit/bb911cc7eca1eeef15ade8eb043c0056c281e311))
+* sends cropped image pixel values to server instead of percent values ([#6852](https://github.com/payloadcms/payload/issues/6852)) ([8747743](https://github.com/payloadcms/payload/commit/874774375f8beada9bac0a8ef3e77f63adc30834))
+
+## [2.22.0](https://github.com/payloadcms/payload/compare/v2.21.0...v2.22.0) (2024-06-20)
+
+
+### Features
+
+* passes prev value through to validate functions ([#6805](https://github.com/payloadcms/payload/issues/6805)) ([0a51de7](https://github.com/payloadcms/payload/commit/0a51de7623d7c7790db52f0cc3e431b5ec3436f2))
+
+
+### Bug Fixes
+
+* adjust json field schema for defaultValue ([#6872](https://github.com/payloadcms/payload/issues/6872)) ([58427ff](https://github.com/payloadcms/payload/commit/58427ffae3e0c1159fae817850b4c1770f43b9b9))
+* array row validation messages ([#6780](https://github.com/payloadcms/payload/issues/6780)) ([68ea693](https://github.com/payloadcms/payload/commit/68ea693a88714951661464917d5df10a416a5ca0))
+* cannot use empty string in defaultValue on text-like fields ([#6842](https://github.com/payloadcms/payload/issues/6842)) ([3364385](https://github.com/payloadcms/payload/commit/336438506ce5e54065f59a0352531e0255f5313d))
+* corrects redirect with lonely slash on login ([#6784](https://github.com/payloadcms/payload/issues/6784)) ([dae56e6](https://github.com/payloadcms/payload/commit/dae56e60eef9e6456d9c51e7fc3b995a32e56f5e))
+* **db-postgres:** cascade delete FKs on hasMany relationships ([#6735](https://github.com/payloadcms/payload/issues/6735)) ([9ecc6c8](https://github.com/payloadcms/payload/commit/9ecc6c889929a07d1163919eac14c9b33b90208a))
+* **payload, db-mongodb:** querying relationships with `in` & `not_in` ([#6773](https://github.com/payloadcms/payload/issues/6773)) ([f6ba3be](https://github.com/payloadcms/payload/commit/f6ba3befaeb02edca66f04fbc2ea91d2d2549d08)), closes [#6741](https://github.com/payloadcms/payload/issues/6741)
+* **plugin-cloud-storage:** missing error handling for invalid plugin config, leading to unexpected webpack errors ([#6786](https://github.com/payloadcms/payload/issues/6786)) ([015aafd](https://github.com/payloadcms/payload/commit/015aafda758938028c37a96e9b5fe62902757b09))
+* **ui:** withinCollapsible always false from useCollapsible provider ([#6783](https://github.com/payloadcms/payload/issues/6783)) ([9f0aaf0](https://github.com/payloadcms/payload/commit/9f0aaf066e76210a85faf43b2b5dc5129ccf3879)), closes [#6760](https://github.com/payloadcms/payload/issues/6760)
+* unflattening json objects containing keys with periods ([#6834](https://github.com/payloadcms/payload/issues/6834)) ([025306f](https://github.com/payloadcms/payload/commit/025306f9e685c030956dad3b0f0158c1dce49668)), closes [#5378](https://github.com/payloadcms/payload/issues/5378)
+* upgrade swc, fixing swc issues on linux ([#6809](https://github.com/payloadcms/payload/issues/6809)) ([1c986a9](https://github.com/payloadcms/payload/commit/1c986a98321163c921cb071a160b6fa9fc8bd9ee))
+
+
+## [2.21.0](https://github.com/payloadcms/payload/compare/v2.20.0...v2.21.0) (2024-06-14)
+
+
+### Features
+
+* draft validation ([#6746](https://github.com/payloadcms/payload/issues/6746)) ([ff70fd9](https://github.com/payloadcms/payload/commit/ff70fd9813ec7dc14bf54d3457c25e145fe01699))
+
+
+### Bug Fixes
+
+* adjust version status pill when unpublished ([#6744](https://github.com/payloadcms/payload/issues/6744)) ([b7e8529](https://github.com/payloadcms/payload/commit/b7e852993beaaa465e38caa36e75e870819516b5))
+* use correct time for isLocked check ([#6052](https://github.com/payloadcms/payload/issues/6052)) ([3b4bb30](https://github.com/payloadcms/payload/commit/3b4bb3065a6d2ac2f7d6aafd0fb4a35b580f3662))
+* unable to save animated file types with undefined image sizes ([#6733](https://github.com/payloadcms/payload/issues/6733)) ([e40570b](https://github.com/payloadcms/payload/commit/e40570bd0d64660bb2ae5b5785b4c85c684ca9ab)), closes [#6727](https://github.com/payloadcms/payload/issues/6727)
+
+## [2.20.0](https://github.com/payloadcms/payload/compare/v2.19.3...v2.20.0) (2024-06-11)
+
+
+### Features
+
+* **ui:** updates draft/published version pills ([#6732](https://github.com/payloadcms/payload/issues/6732)) ([ed86b15](https://github.com/payloadcms/payload/commit/ed86b15242ccbd737f3fe80103afc7d8c4cc6915))
+
+
+### Bug Fixes
+
+* adds multi select inputs for `number` & `text` fields in where builder ([#6662](https://github.com/payloadcms/payload/issues/6662)) ([e3003b4](https://github.com/payloadcms/payload/commit/e3003b443fd3b472670ade228c174c7f755b1732))
+* create sharp file for `fileHasAdjustments` files or `fileIsAnimated` files ([#6710](https://github.com/payloadcms/payload/issues/6710)) ([921a5c0](https://github.com/payloadcms/payload/commit/921a5c065d6089f0118ad8be7adbf75614c8db9c))
+* enable SaveDraft button when creating new documents ([#6672](https://github.com/payloadcms/payload/issues/6672)) ([63bc6ae](https://github.com/payloadcms/payload/commit/63bc6ae52f63adf98f442c2d7992461e7f5f86e4)), closes [#6671](https://github.com/payloadcms/payload/issues/6671) [/github.com/payloadcms/payload/commit/8f03cd7c789eda7613ddced0d45a32afe49b1e01#diff-b7c978f47b1f3beff95c78ad95078e600624cbcd7ac10f9378cc4ad6803db244L75-R79](https://github.com/payloadcms//github.com/payloadcms/payload/commit/8f03cd7c789eda7613ddced0d45a32afe49b1e01/issues/diff-b7c978f47b1f3beff95c78ad95078e600624cbcd7ac10f9378cc4ad6803db244L75-R79)
+* handles localized nested relationship fields in versions ([#6679](https://github.com/payloadcms/payload/issues/6679)) ([8a62298](https://github.com/payloadcms/payload/commit/8a622984e7ce4a2439d5d63e2689404652f8c96b))
+* live preview device position when using zoom ([#6667](https://github.com/payloadcms/payload/issues/6667)) ([9525511](https://github.com/payloadcms/payload/commit/9525511e8bc6bc3fbd7e21e36596404604f1c109))
+* only use `metadata.pages` for height if animated ([#6729](https://github.com/payloadcms/payload/issues/6729)) ([2f9ed34](https://github.com/payloadcms/payload/commit/2f9ed34d13d94070db40b1eabd04655d2e13e094))
+* removes `array` & `blocks` & `group` fields from sort ([#6574](https://github.com/payloadcms/payload/issues/6574)) ([507e095](https://github.com/payloadcms/payload/commit/507e0954b2743012f0b53c396d49461120a02b1a)), closes [#6469](https://github.com/payloadcms/payload/issues/6469)
+* withinCollapsible should be undefined by default ([#6666](https://github.com/payloadcms/payload/issues/6666)) ([37c8386](https://github.com/payloadcms/payload/commit/37c8386a51172966057df3477517d160e1c4a9a7)), closes [#6658](https://github.com/payloadcms/payload/issues/6658)
+
+## [2.19.3](https://github.com/payloadcms/payload/compare/v2.19.2...v2.19.3) (2024-06-07)
+
+
+### Bug Fixes
+
+* scopes uploadEdits to documents, hoists action to doc provider ([#6664](https://github.com/payloadcms/payload/issues/6664)) ([373cb00](https://github.com/payloadcms/payload/commit/373cb0013902b52aba455542e10402316da4b2f4))
+
+## [2.19.2](https://github.com/payloadcms/payload/compare/v2.19.1...v2.19.2) (2024-06-06)
+
+
+### Bug Fixes
+
+* cascade draft arg when querying globals with graphql ([#6651](https://github.com/payloadcms/payload/issues/6651)) ([ac8c209](https://github.com/payloadcms/payload/commit/ac8c2096af641a6886e4543ee65c9790e45f080f))
+* filtered out `disableListColumn` fields reappeared after toggling other fields ([#6636](https://github.com/payloadcms/payload/issues/6636)) ([626be15](https://github.com/payloadcms/payload/commit/626be155784dda181276bb87617433822a0accf3))
+* resizing animated images ([#6621](https://github.com/payloadcms/payload/issues/6621)) ([67c0b0e](https://github.com/payloadcms/payload/commit/67c0b0e6e0b5b190f6a916b59ba02f8c18479e18)), closes [#2181](https://github.com/payloadcms/payload/issues/2181) [#6146](https://github.com/payloadcms/payload/issues/6146)
+
+## [2.19.1](https://github.com/payloadcms/payload/compare/v2.19.0...v2.19.1) (2024-06-04)
+
+
+### Bug Fixes
+
+* override ajv dependency version to 8.14.0 wherever possible ([#6618](https://github.com/payloadcms/payload/issues/6618)) ([e44ce81](https://github.com/payloadcms/payload/commit/e44ce819cefddeaaf20b2b7ce804e94a9272baf1))
+
+## [2.19.0](https://github.com/payloadcms/payload/compare/v2.18.3...v2.19.0) (2024-06-04)
+
+
+### Features
+
+* **translations:** update Turkish translations ([#5738](https://github.com/payloadcms/payload/issues/5738)) ([4fddea8](https://github.com/payloadcms/payload/commit/4fddea86ebd5f21705be2310f8b7053d31109189))
+
+
+### Bug Fixes
+
+* adds new `userEmailAlreadyRegistered` translations ([#6549](https://github.com/payloadcms/payload/issues/6549)) ([56c6700](https://github.com/payloadcms/payload/commit/56c6700cf25570cc217e28dc69459a3b81adbced)), closes [#6535](https://github.com/payloadcms/payload/issues/6535)
+* adjusts sizing of remove/add buttons to be same size ([#6527](https://github.com/payloadcms/payload/issues/6527)) ([a352ebc](https://github.com/payloadcms/payload/commit/a352ebc5520bbd0f6a9caef068825976dba05ded)), closes [#6098](https://github.com/payloadcms/payload/issues/6098)
+* focalPoint undefined handling ([#6552](https://github.com/payloadcms/payload/issues/6552)) ([fcfc3c5](https://github.com/payloadcms/payload/commit/fcfc3c593f69f63c51f8aa09973fcacbfbe04952))
+* pagination on polymorphic relationship field requesting entries with page parameter set to NaN ([#5366](https://github.com/payloadcms/payload/issues/5366)) ([547acfe](https://github.com/payloadcms/payload/commit/547acfe876bdf0df2ce808941f72b690c9dbcae3))
+* safely evaluates `field.admin` in WhereBuilder ([#6534](https://github.com/payloadcms/payload/issues/6534)) ([4f9d78d](https://github.com/payloadcms/payload/commit/4f9d78df5e38f3f70852bb6de47cff619f57c648))
+* separate sort and search fields when looking up relationship. ([#5964](https://github.com/payloadcms/payload/issues/5964)) ([c009219](https://github.com/payloadcms/payload/commit/c0092191a6ded1098a94d9f48918ab79171e5e32)), closes [#4815](https://github.com/payloadcms/payload/issues/4815) [#5222](https://github.com/payloadcms/payload/issues/5222)
+* ui field validation error with `admin.disableListColumn` property ([#6530](https://github.com/payloadcms/payload/issues/6530)) ([eeddece](https://github.com/payloadcms/payload/commit/eeddeceda988d7a4ce8ad31d3036a4ee84aceec3)), closes [#6521](https://github.com/payloadcms/payload/issues/6521)
+* **ui:** blocks browser save dialog from opening when hotkey used with no changes ([#6365](https://github.com/payloadcms/payload/issues/6365)) ([8f03cd7](https://github.com/payloadcms/payload/commit/8f03cd7c789eda7613ddced0d45a32afe49b1e01)), closes [#214](https://github.com/payloadcms/payload/issues/214)
+
 ## [2.18.3](https://github.com/payloadcms/payload/compare/v2.18.2...v2.18.3) (2024-05-17)
 
 

README.md

@@ -99,6 +99,10 @@ If you want to add contributions to this repository, please follow the instructi
 
 The [Examples Directory](./examples) is a great resource for learning how to setup Payload in a variety of different ways, but you can also find great examples in our blog and throughout our social media.
 
+If you'd like to run the examples, you can either copy them to a folder outside this repo or run them directly by (1) navigating to the example's subfolder (`cd examples/your-example-folder`) and (2) using the `--ignore-workspace` flag to bypass workspace restrictions (e.g., `pnpm --ignore-workspace install` or `pnpm --ignore-workspace dev`).
+
+You can see more examples at:
+
 - [Examples Directory](./examples)
 - [Payload Blog](https://payloadcms.com/blog)
 - [Payload YouTube](https://www.youtube.com/@payloadcms)

docs/access-control/collections.mdx

@@ -1,186 +0,0 @@
----
-title: Collection Access Control
-label: Collections
-order: 20
-desc: With Collection-level Access Control you can define which users can create, read, update or delete Collections.
-keywords: collections, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-You can define Collection-level Access Control within each Collection's `access` property. All Access Control functions accept one `args` argument.
-
-## Available Controls
-
-| Function                | Allows/Denies Access                         |
-| ----------------------- | -------------------------------------------- |
-| **[`create`](#create)** | Used in the `create` operation               |
-| **[`read`](#read)**     | Used in the `find` and `findByID` operations |
-| **[`update`](#update)** | Used in the `update` operation               |
-| **[`delete`](#delete)** | Used in the `delete` operation               |
-
-#### Auth-enabled Controls
-
-If a Collection supports [`Authentication`](/docs/authentication/overview), the following Access Controls become available:
-
-| Function                | Allows/Denies Access                                           |
-| ----------------------- | -------------------------------------------------------------- |
-| **[`admin`](#admin)**   | Used to restrict access to the Payload Admin panel             |
-| **[`unlock`](#unlock)** | Used to restrict which users can access the `unlock` operation |
-
-**Example Collection config:**
-
-```ts
-import { CollectionConfig } from 'payload/types';
-
-export const Posts: CollectionConfig = {
-  slug: "posts",
-  // highlight-start
-  access: {
-    create: ({ req: { user } }) => { ... },
-    read: ({ req: { user } }) => { ... },
-    update: ({ req: { user } }) => { ... },
-    delete: ({ req: { user } }) => { ... },
-    admin: ({ req: { user } }) => { ... },
-  },
-  // highlight-end
-};
-```
-
-### Create
-
-Returns a boolean which allows/denies access to the `create` request.
-
-**Available argument properties:**
-
-| Option     | Description                                                                |
-| ---------- | -------------------------------------------------------------------------- |
-| **`req`**  | The Express `request` object containing the currently authenticated `user` |
-| **`data`** | The data passed to create the document with.                               |
-
-**Example:**
-
-```ts
-const PublicUsers = {
-  slug: 'public-users',
-  access: {
-    // highlight-start
-    // allow guest users to self-registration
-    create: () => true,
-    // highlight-end
-    ...
-  },
-  fields: [ ... ],
-}
-```
-
-### Read
-
-Read access functions can return a boolean result or optionally return a [query constraint](/docs/queries/overview) which limits the documents that are returned to only those that match the constraint you provide. This can be helpful to restrict users' access to only certain documents however you specify.
-
-**Available argument properties:**
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The Express `request` object containing the currently authenticated `user` |
-| **`id`**  | `id` of document requested, if within `findByID`                           |
-
-**Example:**
-
-```ts
-import { Access } from 'payload/config'
-
-const canReadPage: Access = ({ req: { user } }) => {
-  // allow authenticated users
-  if (user) {
-    return true
-  }
-  // using a query constraint, guest users can access when a field named 'isPublic' is set to true
-  return {
-    // assumes we have a checkbox field named 'isPublic'
-    isPublic: {
-      equals: true,
-    },
-  }
-}
-```
-
-### Update
-
-Update access functions can return a boolean result or optionally return a [query constraint](/docs/queries/overview) to limit the document(s) that can be updated by the currently authenticated user. For example, returning a `query` from the `update` Access Control is helpful in cases where you would like to restrict a user to only being able to update the documents containing a `createdBy` relationship field equal to the user's ID.
-
-**Available argument properties:**
-
-| Option     | Description                                                                |
-| ---------- | -------------------------------------------------------------------------- |
-| **`req`**  | The Express `request` object containing the currently authenticated `user` |
-| **`id`**   | `id` of document requested to update                                       |
-| **`data`** | The data passed to update the document with                                |
-
-**Example:**
-
-```ts
-import { Access } from 'payload/config'
-
-const canUpdateUser: Access = ({ req: { user }, id }) => {
-  // allow users with a role of 'admin'
-  if (user.roles && user.roles.some((role) => role === 'admin')) {
-    return true
-  }
-  // allow any other users to update only oneself
-  return user.id === id
-}
-```
-
-### Delete
-
-Similarly to the Update function, returns a boolean or a [query constraint](/docs/queries/overview) to limit which documents can be deleted by which users.
-
-**Available argument properties:**
-
-| Option    | Description                                                                                         |
-| --------- | --------------------------------------------------------------------------------------------------- |
-| **`req`** | The Express `request` object with additional `user` property, which is the currently logged in user |
-| **`id`**  | `id` of document requested to delete                                                                |
-
-**Example:**
-
-```ts
-import { Access } from 'payload/config'
-
-const canDeleteCustomer: Access = async ({ req, id }) => {
-  if (!id) {
-    // allow the admin UI to show controls to delete since it is indeterminate without the id
-    return true
-  }
-  // query another collection using the id
-  const result = await req.payload.find({
-    collection: 'contracts',
-    limit: 0,
-    depth: 0,
-    where: {
-      customer: { equals: id },
-    },
-  })
-
-  return result.totalDocs === 0
-}
-```
-
-### Admin
-
-If the Collection is [used to access the Payload Admin panel](/docs/admin/overview#the-admin-user-collection), the `Admin` Access Control function determines whether or not the currently logged in user can access the admin UI.
-
-**Available argument properties:**
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The Express `request` object containing the currently authenticated `user` |
-
-### Unlock
-
-Determines which users can [unlock](/docs/authentication/operations#unlock) other users who may be blocked from authenticating successfully due to [failing too many login attempts](/docs/authentication/config#options).
-
-**Available argument properties:**
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The Express `request` object containing the currently authenticated `user` |

docs/access-control/fields.mdx

@@ -1,81 +0,0 @@
----
-title: Field-level Access Control
-label: Fields
-order: 30
-desc: Field-level Access Control is specified within a field's config, and allows you to define which users can create, read or update Fields.
-keywords: fields, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Field Access Control is specified with functions inside a field's config. All field-level Controls return a boolean value to allow or deny access for the specified operation. No field-level Access Controls support returning query constraints. All Access Control functions accept one `args` argument.
-
-## Available Controls
-
-| Function                | Purpose                                                                          |
-| ----------------------- | -------------------------------------------------------------------------------- |
-| **[`create`](#create)** | Allows or denies the ability to set a field's value when creating a new document |
-| **[`read`](#read)**     | Allows or denies the ability to read a field's value                             |
-| **[`update`](#update)** | Allows or denies the ability to update a field's value                           |
-
-**Example Collection config:**
-
-```ts
-import { CollectionConfig } from 'payload/types';
-
-export const Posts: CollectionConfig = {
-  slug: 'posts',
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-      // highlight-start
-      access: {
-        create: ({ req: { user } }) => { ... },
-        read: ({ req: { user } }) => { ... },
-        update: ({ req: { user } }) => { ... },
-      },
-      // highlight-end
-    };
-  ],
-};
-```
-
-### Create
-
-Returns a boolean which allows or denies the ability to set a field's value when creating a new document. If `false` is returned, any passed values will be discarded.
-
-**Available argument properties:**
-
-| Option            | Description                                                                |
-| ----------------- | -------------------------------------------------------------------------- |
-| **`req`**         | The Express `request` object containing the currently authenticated `user` |
-| **`data`**        | The full data passed to create the document.                               |
-| **`siblingData`** | Immediately adjacent field data passed to create the document.             |
-
-### Read
-
-Returns a boolean which allows or denies the ability to read a field's value. If `false`, the entire property is omitted from the resulting document.
-
-**Available argument properties:**
-
-| Option            | Description                                                                |
-| ----------------- | -------------------------------------------------------------------------- |
-| **`req`**         | The Express `request` object containing the currently authenticated `user` |
-| **`id`**          | `id` of the document being read                                            |
-| **`doc`**         | The full document data.                                                    |
-| **`siblingData`** | Immediately adjacent field data of the document being read.                |
-
-### Update
-
-Returns a boolean which allows or denies the ability to update a field's value. If `false` is returned, any passed values will be discarded.
-
-If `false` is returned and you attempt to update the field's value, the operation will **not** throw an error however the field will be omitted from the update operation and the value will remain unchanged.
-
-**Available argument properties:**
-
-| Option            | Description                                                                |
-| ----------------- | -------------------------------------------------------------------------- |
-| **`req`**         | The Express `request` object containing the currently authenticated `user` |
-| **`id`**          | `id` of the document being updated                                         |
-| **`data`**        | The full data passed to update the document.                               |
-| **`siblingData`** | Immediately adjacent field data passed to update the document with.        |
-| **`doc`**         | The full document data, before the update is applied.                      |

docs/access-control/globals.mdx

@@ -1,61 +0,0 @@
----
-title: Globals Access Control
-label: Globals
-order: 40
-desc: Global-level Access Control is specified within each Global's `access` property and allows you to define which users can read or update Globals.
-keywords: globals, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-You can define Global-level Access Control within each Global's `access` property. All Access Control functions accept one `args` argument.
-
-\*\*Available argument properties:
-
-## Available Controls
-
-| Function                | Allows/Denies Access                   |
-| ----------------------- | -------------------------------------- |
-| **[`read`](#read)**     | Used in the `findOne` Global operation |
-| **[`update`](#update)** | Used in the `update` Global operation  |
-
-**Example Global config:**
-
-```ts
-import { GlobalConfig } from 'payload/types'
-
-const Header: GlobalConfig = {
-  slug: 'header',
-  // highlight-start
-  access: {
-    read: ({ req: { user } }) => {
-      /* */
-    },
-    update: ({ req: { user } }) => {
-      /* */
-    },
-  },
-  // highlight-end
-}
-
-export default Header
-```
-
-### Read
-
-Returns a boolean result or optionally a [query constraint](/docs/queries/overview) which limits who can read this global based on its current properties.
-
-**Available argument properties:**
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The Express `request` object containing the currently authenticated `user` |
-
-### Update
-
-Returns a boolean result or optionally a [query constraint](/docs/queries/overview) which limits who can update this global based on its current properties.
-
-**Available argument properties:**
-
-| Option     | Description                                                                |
-| ---------- | -------------------------------------------------------------------------- |
-| **`req`**  | The Express `request` object containing the currently authenticated `user` |
-| **`data`** | The data passed to update the global with.                                 |

docs/access-control/overview.mdx

@@ -1,83 +0,0 @@
----
-title: Access Control
-label: Overview
-order: 10
-desc: Payload makes it simple to define and manage access control. By declaring roles, you can set permissions and restrict what your users can interact with.
-keywords: overview, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Access control within Payload is extremely powerful while remaining easy and intuitive to manage. Declaring who should have access to what documents is no more complex than writing a simple JavaScript function that either returns a `boolean` or a [`query`](/docs/queries/overview) constraint to restrict which documents users can interact with.
-
-<YouTube id="DoPLyXG26Dg" title="Overview of Payload Access Control" />
-
-**Example use cases:**
-
-- Allowing anyone `read` access to all `Post`s
-- Only allowing public access to `Post`s where a `status` field is equal to `published`
-- Giving only `User`s with a `role` field equal to `admin` the ability to delete `Page`(s)
-- Allowing anyone to create `ContactSubmission`s, but only logged in users to `read`, `update` or `delete` them
-- Restricting a `User` to only be able to see their own `Order`(s), but no others
-- Allowing `User`s that belong to a certain `Organization` to access only that `Organization`'s `Resource`s
-
-### Default Settings
-
-**By default, all Collections and Globals require that a user is logged in to be able to interact in any way.** The default Access Control function evaluates the `user` from the Express `req` and returns `true` if a user is logged in, and `false` if not.
-
-**Default Access function:**
-
-```ts
-const defaultPayloadAccess = ({ req: { user } }) => {
-  // Return `true` if a user is found
-  // and `false` if it is undefined or null
-  return Boolean(user)
-}
-```
-
-<Banner type="success">
-  <strong>Note:</strong>
-  <br />
-  In the Local API, all Access Control functions are skipped by default, allowing your server to do
-  whatever it needs. But, you can opt back in by setting the option <strong>
-    overrideAccess
-  </strong>{' '}
-  to <strong>false</strong>.
-</Banner>
-
-### Access Control Types
-
-You can manage access within Payload on three different levels:
-
-- [Collections](/docs/access-control/collections)
-- [Fields](/docs/access-control/fields)
-- [Globals](/docs/access-control/globals)
-
-### When Access Control is Executed
-
-<Banner type="success">
-  <strong>Note:</strong>
-  <br />
-  Access control functions are utilized in two places. It's important to understand how and when
-  your access control is executed.
-</Banner>
-
-#### As you execute operations
-
-When you perform Payload operations like `create`, `read`, `update`, and `delete`, your access control functions will be executed before any changes or operations are completed.
-
-#### Within the Admin UI
-
-The Payload Admin UI responds dynamically to the access control that you define. For example, if you restrict editing a `ExampleCollection` to only users that feature a `role` of `admin`, the Payload Admin UI will **hide** the `ExampleCollection` from the Admin UI entirely. This is super powerful and allows you to control who can do what with your Admin UI.
-
-To accomplish this, Payload ships with an `Access` operation, which is executed when a user logs into the Admin UI. Payload will execute each one of your access control functions, across all collections, globals, and fields, at the top level and return a response that contains a reflection of what the currently authenticated user can do with your application.
-
-### Argument Availability
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  When your access control functions are executed via the <strong>access</strong> operation, the{' '}
-  <strong>id</strong> and <strong>data</strong> arguments will be <strong>undefined</strong>,
-  because Payload is executing your functions without referencing a specific document.
-</Banner>
-
-If you use `id` or `data` within your access control functions, make sure to check that they are defined first. If they are not, then you can assume that your access control is being executed via the `access` operation, to determine solely what the user can do within the Admin UI.

docs/admin/bundlers.mdx

@@ -1,54 +0,0 @@
----
-title: Bundlers
-label: Bundlers
-order: 60
-desc: Bundlers are used to bundle the code that serves Payload's Admin Panel.
----
-
-Payload has two official bundlers, the [Webpack Bundler](/docs/admin/webpack) and the [Vite Bundler](/docs/admin/vite). You must install a bundler to use the admin panel.
-
-##### Install a bundler
-
-Webpack (recommended):
-
-```text
-yarn add @payloadcms/bundler-webpack
-```
-
-Vite (beta):
-
-```text
-yarn add @payloadcms/bundler-vite
-```
-
-##### Configure the bundler
-
-```ts
-// payload.config.ts
-
-import { buildConfig } from 'payload/config'
-import { webpackBundler } from '@payloadcms/bundler-webpack'
-// import { viteBundler } from '@payloadcms/bundler-vite'
-
-export default buildConfig({
-  // highlight-start
-  admin: {
-    bundler: webpackBundler() // or viteBundler()
-  },
-  // highlight-end
-})
-```
-
-### What are bundlers?
-
-At their core, a bundler's main goal is to take a bunch of files and turn them into a few optimized files that you ship to the browser. The admin UI has a root `index.html` entry point, and from there the bundler traverses the dependency tree, bundling all of the files that are required from that point on.
-
-Since the bundled file is sent to the browser, it can't include any server-only code. You will need to remove any server-only code from your admin UI before bundling it. You can learn more about [excluding server code](/docs/admin/excluding-server-code) section.
-
-<Banner type="warning">
-  <strong>Using environment variables in the admin UI</strong>
-  <br />
-  Bundles should not contain sensitive information. By default, Payload
-  excludes env variables from the bundle. If you need to use env variables in your payload config,
-  you need to prefix them with `PAYLOAD_PUBLIC_` to make them available to the client-side code.
-</Banner>

docs/admin/components.mdx

@@ -1,711 +0,0 @@
----
-title: Swap in your own React components
-label: Custom Components
-order: 20
-desc: Fully customize your Admin Panel by swapping in your own React components. Add fields, remove views, update routes and change functions to sculpt your perfect Dashboard.
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-While designing the Payload Admin panel, we determined it should be as minimal and straightforward as possible to allow easy customization and control. There are many times where you may want to completely control how a whole view or a field works. You might even want to add in new views entirely. In order for Payload to support this level of customization without introducing versioning / future-proofing issues, Payload provides for a pattern to supply your own React components via your Payload config.
-
-To swap in your own React component, first, consult the list of available component overrides below. Determine the scope that corresponds to what you are trying to accomplish, and then author your React component accordingly.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  Custom components will automatically be provided with all props that the default component normally
-  accepts.
-</Banner>
-
-### Base Component Overrides
-
-You can override a set of admin panel-wide components by providing a component to your base Payload config's `admin.components` property. The following options are available:
-
-| Path                  | Description                                                                                                                                                                                                 |
-| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                         |
-| **`BeforeNavLinks`**  | Array of components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                         |
-| **`AfterNavLinks`**   | Array of components to inject into the built-in Nav, _after_ the links.                                                                                                                                     |
-| **`BeforeDashboard`** | Array of components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                         |
-| **`AfterDashboard`**  | Array of components to inject into the built-in Dashboard, _after_ the default dashboard contents. [Demo](https://github.com/payloadcms/payload/tree/main/test/admin/components/AfterDashboard/index.tsx)   |
-| **`BeforeLogin`**     | Array of components to inject into the built-in Login, _before_ the default login form.                                                                                                                     |
-| **`AfterLogin`**      | Array of components to inject into the built-in Login, _after_ the default login form.                                                                                                                      |
-| **`logout.Button`**   | A custom React component.                                                                                                                                                                                   |
-| **`graphics.Icon`**   | Used as a graphic within the `Nav` component. Often represents a condensed version of a full logo.                                                                                                          |
-| **`graphics.Logo`**   | The full logo to be used in contexts like the `Login` view.                                                                                                                                                 |
-| **`providers`**       | Define your own provider components that will wrap the Payload Admin UI. [More](#custom-providers)                                                                                                          |
-| **`actions`**         | Array of custom components to be rendered in the Payload Admin UI header, providing additional interactivity and functionality.                                                                             |
-| **`views`**           | Override or create new views within the Payload Admin UI. [More](#views)                                                                                                                                    |
-
-Here is a full example showing how to swap some of these components for your own.
-
-`payload.config.js`
-
-```ts
-import { buildConfig } from 'payload/config'
-
-import {
-  MyCustomNav,
-  MyCustomLogo,
-  MyCustomIcon,
-  MyCustomAccount,
-  MyCustomDashboard,
-  MyProvider,
-  MyCustomAdminAction,
-} from './customComponents'
-
-export default buildConfig({
-  admin: {
-    components: {
-      Nav: MyCustomNav,
-      graphics: {
-        Icon: MyCustomIcon,
-        Logo: MyCustomLogo,
-      },
-      actions: [MyCustomAdminAction],
-      views: {
-        Account: MyCustomAccount,
-        Dashboard: MyCustomDashboard,
-      },
-      providers: [MyProvider],
-    },
-  },
-})
-```
-
-#### Views
-
-You can easily swap entire views with your own by using the `admin.components.views` property. At the root level, Payload renders the following views by default, all of which can be overridden:
-
-| Property           | Description                                                                                                                  |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`Account`**      | The Account view is used to show the currently logged in user's Account page.                                                |
-| **`Dashboard`**    | The main landing page of the Admin panel.                                                                                    |
-
-To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. For example:
-
-```ts
-// payload.config.ts
-{
-  // ...
-  admin: {
-    components: {
-      views: {
-        Account: MyCustomAccountView,
-        Dashboard: MyCustomDashboardView,
-      },
-    },
-  },
-}
-```
-
-For more granular control, pass a configuration object instead. Each view corresponds to its own `<Route />` component in [React Router v5](https://v5.reactrouter.com). Payload exposes all of the properties of React Router:
-
-| Property           | Description                                                                                                                  |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`Component`** \* | Pass in the component that should be rendered when a user navigates to this route.                                           |
-| **`path`** \*      | React Router `path`. [See the React Router docs](https://v5.reactrouter.com/web/api/Route/path-string-string) for more info. |
-| **`exact`**        | React Router `exact` property. [More](https://v5.reactrouter.com/web/api/Route/exact-bool)                                   |
-| **`strict`**       | React Router `strict` property. [More](https://v5.reactrouter.com/web/api/Route/strict-bool)                                 |
-| **`sensitive`**    | React Router `sensitive` property. [More](https://v5.reactrouter.com/web/api/Route/sensitive-bool)                           |
-
-_\* An asterisk denotes that a property is required._
-
-#### Adding new views
-
-To add a _new_ view to the Admin Panel, simply add another key to the `views` object with at least a `path` and `Component` property. For example:
-
-```ts
-// payload.config.ts
-{
-  // ...
-  admin: {
-    components: {
-      views: {
-        MyCustomView: {
-          Component: MyCustomView,
-          path: '/my-custom-view',
-        },
-      },
-    },
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  Routes are cascading. This means that unless explicitly given the `exact` property, they will match on URLs that simply _start_ with the route's path. This is helpful when creating catch-all routes in your application. Alternatively, you could define your nested route _before_ your parent route.
-</Banner>
-
-_For more examples regarding how to customize components, look at the following [examples](https://github.com/payloadcms/payload/tree/main/test/admin/components)._
-
-For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component).
-
-### Collections
-
-You can override components on a collection-by-collection basis via the `admin.components` property.
-
-| Path                       | Description                                                                                                            |
-| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| **`BeforeList`**           | Array of components to inject _before_ the built-in List view                                                          |
-| **`BeforeListTable`**      | Array of components to inject _before_ the built-in List view's table                                                  |
-| **`AfterList`**            | Array of components to inject _after_ the built-in List view                                                           |
-| **`AfterListTable`**       | Array of components to inject _after_ the built-in List view's table                                                   |
-| **`edit.SaveButton`**      | Replace the default `Save` button with a custom component. Drafts must be disabled                                     |
-| **`edit.SaveDraftButton`** | Replace the default `Save Draft` button with a custom component. Drafts must be enabled and autosave must be disabled. |
-| **`edit.PublishButton`**   | Replace the default `Publish` button with a custom component. Drafts must be enabled.                                  |
-| **`edit.PreviewButton`**   | Replace the default `Preview` button with a custom component.                                                          |
-| **`views`**                | Override or create new views within the Payload Admin UI. [More](#collection-views)                                    |
-
-Here is a full example showing how to swap some of these components for your own:
-
-`Collection.ts`
-
-```tsx
-import * as React from 'react'
-
-import {
-  CustomSaveButtonProps,
-  CustomSaveDraftButtonProps,
-  CustomPublishButtonType,
-  CustomPreviewButtonProps,
-} from 'payload/types'
-
-export const CustomSaveButton: CustomSaveButtonProps = ({ DefaultButton, label, save }) => {
-  return <DefaultButton label={label} save={save} />
-}
-
-export const CustomSaveDraftButton: CustomSaveDraftButtonProps = ({
-  DefaultButton,
-  disabled,
-  label,
-  saveDraft,
-}) => {
-  return <DefaultButton label={label} disabled={disabled} saveDraft={saveDraft} />
-}
-
-export const CustomPublishButton: CustomPublishButtonType = ({
-  DefaultButton,
-  disabled,
-  label,
-  publish,
-}) => {
-  return <DefaultButton label={label} disabled={disabled} publish={publish} />
-}
-
-export const CustomPreviewButton: CustomPreviewButtonProps = ({
-  DefaultButton,
-  disabled,
-  label,
-  preview,
-}) => {
-  return <DefaultButton label={label} disabled={disabled} preview={preview} />
-}
-
-export const MyCollection: SanitizedCollectionConfig = {
-  slug: 'my-collection',
-  admin: {
-    components: {
-      edit: {
-        SaveButton: CustomSaveButton,
-        SaveDraftButton: CustomSaveDraftButton,
-        PublishButton: CustomPublishButton,
-        PreviewButton: CustomPreviewButton,
-      },
-    },
-  }
-}
-```
-
-#### Collection views
-
-To swap out entire views on collections, you can use the `admin.components.views` property on the collection's config. Payload renders the following views by default, all of which can be overridden:
-
-| Property           | Description                                                                                                                  |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`Edit`**         | The Edit view is used to edit a single document for a given collection.                                                      |
-| **`List`**         | The List view is used to show a list of documents for a given collection.                                                    |
-
-To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, tabs, etc, _as well as all nested routes_.
-
-```ts
-// Collection.ts
-{
-  // ...
-  admin: {
-    components: {
-      views: {
-        Edit: MyCustomEditView,
-        List: MyCustomListView,
-      },
-    },
-  },
-}
-```
-
-_For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component)._
-
-**Customizing Nested Views within 'Edit' in Collections**
-
-The `Edit` view in collections consists of several nested views, each serving a unique purpose. You can customize these nested views using the `admin.components.views.Edit` property in the collection's configuration. This approach allows you to replace specific nested views while keeping the overall structure of the `Edit` view intact, including the page breadcrumbs, title, tabs, etc.
-
-Here's an example of how you can customize nested views within the `Edit` view in collections, including the use of the `actions` property:
-
-```ts
-// Collection.ts
-{
-  // ...
-  admin: {
-    components: {
-      views: {
-        Edit: {
-          Default: {
-            Component: MyCustomDefaultTab,
-            actions: [CollectionEditButton], // Custom actions for the default edit view
-          },
-          API: {
-            Component: MyCustomAPIView,
-            actions: [CollectionAPIButton], // Custom actions for API view
-          },
-          LivePreview: {
-            Component: MyCustomLivePreviewView,
-            actions: [CollectionLivePreviewButton], // Custom actions for Live Preview
-          },
-          Version: {
-            Component: MyCustomVersionView,
-            actions: [CollectionVersionButton], // Custom actions for Version view
-          },
-          Versions: {
-            Component: MyCustomVersionsView,
-            actions: [CollectionVersionsButton], // Custom actions for Versions view
-          },
-        },
-        List: {
-          actions: [CollectionListButton],
-        },
-      },
-    },
-  },
-}
-```
-
-**Adding New Tabs to 'Edit' View**
-
-You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
-
-### Globals
-
-As with Collections, you can override components on a global-by-global basis via the `admin.components` property.
-
-| Path                           | Description                                                                                                            |
-| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| **`elements.SaveButton`**      | Replace the default `Save` button with a custom component. Drafts must be disabled                                     |
-| **`elements.SaveDraftButton`** | Replace the default `Save Draft` button with a custom component. Drafts must be enabled and autosave must be disabled. |
-| **`elements.PublishButton`**   | Replace the default `Publish` button with a custom component. Drafts must be enabled.                                  |
-| **`elements.PreviewButton`**   | Replace the default `Preview` button with a custom component.                                                          |
-| **`views`**                    | Override or create new views within the Payload Admin UI. [More](#global-views)                                        |
-
-#### Global views
-
-To swap out views for globals, you can use the `admin.components.views` property on the global's config. Payload renders the following views by default, all of which can be overridden:
-
-| Property           | Description                                                                                                                  |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`Edit`**         | The Edit view is used to edit a single document for a given Global.                                                          |
-
-To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, and tabs, _as well as all nested views_.
-
-```ts
-// Global.ts
-{
-  // ...
-  admin: {
-    components: {
-      views: {
-        Edit: MyCustomEditView,
-      },
-    },
-  },
-}
-```
-
-_For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component)._
-
-**Customizing Nested Views within 'Edit' in Globals**
-
-Similar to collections, Globals allow for detailed customization within the `Edit` view. This includes the ability to swap specific nested views while maintaining the overall structure of the `Edit` view. You can use the `admin.components.views.Edit` property in the Globals configuration to achieve this, and this will only replace the nested view, leaving the page breadcrumbs, title, and tabs intact.
-
-Here's how you can customize nested views within the `Edit` view in Globals, including the use of the `actions` property:
-
-```ts
-// Global.ts
-{
-  // ...
-  admin: {
-    components: {
-      views: {
-        Edit: {
-          Default: {
-            Component: MyCustomGlobalDefaultTab,
-            actions: [GlobalEditButton], // Custom actions for the default edit view
-          },
-          API: {
-            Component: MyCustomGlobalAPIView,
-            actions: [GlobalAPIButton], // Custom actions for API view
-          },
-          LivePreview: {
-            Component: MyCustomGlobalLivePreviewView,
-            actions: [GlobalLivePreviewButton], // Custom actions for Live Preview
-          },
-          Version: {
-            Component: MyCustomGlobalVersionView,
-            actions: [GlobalVersionButton], // Custom actions for Version view
-          },
-          Versions: {
-            Component: MyCustomGlobalVersionsView,
-            actions: [GlobalVersionsButton], // Custom actions for Versions view
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
-
-### Custom Tabs
-
-You can easily swap individual collection or global edit views. To do this, pass an _object_ to the `admin.components.views.Edit` property of the config. Payload renders the following views by default, all of which can be overridden:
-
-| Property           | Description                                                                                                                  |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`Default`**      | The Default view is the primary view in which your document is edited.                                                       |
-| **`Versions`**     | The Versions view is used to view the version history of a single document. [More details](../versions)                      |
-| **`Version`**      | The Version view is used to view a single version of a single document for a given collection. [More details](../versions).  |
-| **`API`**          | The API view is used to display the REST API JSON response for a given document.                                             |
-| **`LivePreview`**  | The LivePreview view is used to display the Live Preview interface. [More details](../live-preview)                          |
-
-Here is an example:
-
-```ts
-// Collection.ts or Global.ts
-export const MyCollection: SanitizedCollectionConfig = {
-  slug: 'my-collection',
-  admin: {
-    components: {
-      views: {
-        Edit: { // You can also define `components.views.Edit` as a component, this will override _all_ nested views
-          Default: MyCustomDefaultTab,
-          Versions: MyCustomVersionsTab,
-          Version: MyCustomVersionTab,
-          API: MyCustomAPITab,
-          LivePreview: MyCustomLivePreviewTab,
-        },
-      },
-    },
-  },
-}
-```
-
-To add a _new_ tab to the `Edit` view, simply add another key to `components.views.Edit[key]` with at least a `path` and `Component` property. For example:
-
-```ts
-// `Collection.ts` or `Global.ts`
-export const MyCollection: SanitizedCollectionConfig = {
-  slug: 'my-collection',
-  admin: {
-    components: {
-      views: {
-        Edit: {
-          MyCustomTab: {
-            Component: MyCustomTab,
-            path: '/my-custom-tab',
-            // You an swap the entire tab component out for your own
-            Tab: MyCustomTab
-          },
-          AnotherCustomView: {
-            Component: AnotherCustomView,
-            path: '/another-custom-view',
-            // Or you can use the default tab component and just pass in your own label and href
-            Tab: {
-              label: 'Another Custom View',
-              href: '/another-custom-view',
-            }
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-### Building a custom view component
-
-Your custom view components will be given all the props that a React Router `<Route />` typically would receive, as well as two props from Payload:
-
-| Prop                    | Description                                                                  |
-| ----------------------- | ---------------------------------------------------------------------------- |
-| **`user`**              | The currently logged in user. Will be `null` if no user is logged in.        |
-| **`canAccessAdmin`** \* | If the currently logged in user is allowed to access the admin panel or not. |
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  It's up to you to secure your custom views. 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>
-
-#### Example
-
-You can find examples of custom views in the [Payload source code `/test/admin/components/views` folder](https://github.com/payloadcms/payload/tree/main/test/admin/components/views). There, you'll find two custom views:
-
-1. A custom view that uses the `DefaultTemplate`, which is the built-in Payload template that displays the sidebar and "eyebrow nav"
-1. A custom view that uses the `MinimalTemplate` - which is just a centered template used for things like logging in or out
-
-To see how to pass in your custom views to create custom views of your own, take a look at the `admin.components.views` property of the [Payload test admin config](https://github.com/payloadcms/payload/blob/main/test/admin/config.ts).
-
-### Fields
-
-All Payload fields support the ability to swap in your own React components. So, for example, instead of rendering a default Text input, you might need to render a color picker that provides the editor with a custom color picker interface to restrict the data entered to colors only.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  Don't see a built-in field type that you need? Build it! Using a combination of custom validation
-  and custom components, you can override the entirety of how a component functions within the admin
-  panel and effectively create your own field type.
-</Banner>
-
-**Fields support the following custom components:**
-
-| Component    | Description                                                                                                                 |
-| ------------ | --------------------------------------------------------------------------------------------------------------------------- |
-| **`Filter`** | Override the text input that is presented in the `List` view when a user is filtering documents by the customized field.    |
-| **`Cell`**   | Used in the `List` view's table to represent a table-based preview of the data stored in the field. [More](#cell-component) |
-| **`Field`**  | Swap out the field itself within all `Edit` views. [More](#field-component)                                                 |
-
-As an alternative to replacing the entire Field component, you may want to keep the majority of the default Field component and only swap components within. This allows you to replace the **`Label`** or **`Error`** within a field component or add additional components inside the field with **`beforeInput`** or **`afterInput`**. **`beforeInput`** and **`afterInput`** are allowed in any fields that don't contain other fields, except [UI](/docs/fields/ui) and [Rich Text](/docs/fields/rich-text).
-
-| Component         | Description                                                                                                     |
-| ----------------- | --------------------------------------------------------------------------------------------------------------- |
-| **`Label`**       | Override the default Label in the Field Component. [More](#label-component)                                     |
-| **`Error`**       | Override the default Label in the Field Component. [More](#error-component)                                     |
-| **`beforeInput`** | An array of elements that will be added before `input`/`textarea` elements. [More](#afterinput-and-beforeinput) |
-| **`afterInput`**  | An array of elements that will be added after `input`/`textarea` elements. [More](#afterinput-and-beforeinput)  |
-
-## Cell Component
-
-These are the props that will be passed to your custom Cell to use in your own components.
-
-| Property         | Description                                                       |
-| ---------------- | ----------------------------------------------------------------- |
-| **`field`**      | An object that includes the field configuration.                  |
-| **`colIndex`**   | A unique number for the column in the list.                       |
-| **`collection`** | An object with the config of the collection that the field is in. |
-| **`cellData`**   | The data for the field that the cell represents.                  |
-| **`rowData`**    | An object with all the field values for the row.                  |
-
-#### Example
-
-```tsx
-import React from 'react'
-import type { Props } from 'payload/components/views/Cell'
-import './index.scss'
-
-const baseClass = 'custom-cell'
-
-const CustomCell: React.FC<Props> = (props) => {
-  const { field, colIndex, collection, cellData, rowData } = props
-
-  return <span className={baseClass}>{cellData}</span>
-}
-```
-
-## Field Component
-
-When writing your own custom components you can make use of a number of hooks to set data, get reactive changes to other fields, get the id of the document or interact with a context from a custom provider.
-
-### Sending and receiving values from the form
-
-When swapping out the `Field` component, you'll be responsible for sending and receiving the field's `value` from the form itself. To do so, import the `useField` hook as follows:
-
-```tsx
-import { useField } from 'payload/components/forms'
-
-const CustomTextField: React.FC<{ path: string }> = ({ path }) => {
-  // highlight-start
-  const { value, setValue } = useField<string>({ path })
-  // highlight-end
-
-
-  return <input onChange={(e) => setValue(e.target.value)} value={value} />
-}
-```
-
-<Banner type="success">
-  For more information regarding the hooks that are available to you while you build custom
-  components, including the <strong>useField</strong> hook, [click here](/docs/admin/hooks).
-</Banner>
-
-## Label Component
-
-These are the props that will be passed to your custom Label.
-
-| Property         | Description                                                      |
-| ---------------- | ---------------------------------------------------------------- |
-| **`htmlFor`**    | Property used to set `for` attribute for label.                  |
-| **`label`**      | Label value provided in field, it can be used with i18n.         |
-| **`required`**   | A boolean value that represents if the field is required or not. |
-
-#### Example
-
-```tsx
-import React from 'react'
-import { useTranslation } from 'react-i18next'
-
-import { getTranslation } from 'payload/utilities/getTranslation'
-
-type Props = {
-  htmlFor?: string
-  label?: Record<string, string> | false | string
-  required?: boolean
-}
-
-const CustomLabel: React.FC<Props> = (props) => {
-  const { htmlFor, label, required = false } = props
-
-  const { i18n } = useTranslation()
-
-  if (label) {
-    return (<span>
-      {getTranslation(label, i18n)}
-      {required && <span className="required">*</span>}
-    </span>);
-  }
-
-  return null
-}
-```
-
-## Error Component
-
-These are the props that will be passed to your custom Error.
-
-| Property         | Description                                                   |
-| ---------------- | ------------------------------------------------------------- |
-| **`message`**    | The error message.                                            |
-| **`showError`**  | A boolean value that represents if the error should be shown. |
-
-#### Example
-
-```tsx
-import React from 'react'
-
-type Props = {
-  message: string
-  showError?: boolean
-}
-
-const CustomError: React.FC<Props> = (props) => {
-  const { message, showError } = props
-
-  if (showError) {
-    return <p style={{color: 'red'}}>{message}</p>
-  } else return null;
-}
-```
-
-## afterInput and beforeInput
-
-With these properties you can add multiple components before and after the input element. For example, you can add an absolutely positioned button to clear the current field value.
-
-#### Example
-
-```tsx
-import React from 'react'
-import { Field } from 'payload/types'
-
-import './style.scss'
-
-const ClearButton: React.FC = () => {
-  return <button onClick={() => {/* ... */}}>X</button>
-}
-
-const titleField: Field = {
-  name: 'title',
-  type: 'text',
-  admin: {
-    components: {
-      afterInput: [ClearButton]
-    }
-  }
-}
-
-export default titleField;
-```
-
-## Custom providers
-
-As your admin customizations gets more complex you may want to share state between fields or other components. You can add custom providers to do add your own context to any Payload app for use in other custom components within the admin panel. Within your config add `admin.components.providers`, these can be used to share context or provide other custom functionality. Read the [React context](https://reactjs.org/docs/context.html) docs to learn more.
-
-<Banner type="warning">
-  <strong>Reminder:</strong> Don't forget to pass the **children** prop through the provider
-  component for the admin UI to show
-</Banner>
-
-### Styling Custom Components
-
-Payload exports its SCSS variables and mixins for reuse in your own custom components. This is helpful in cases where you might want to style a custom input similarly to Payload's built-in styling, so it blends more thoroughly into the existing admin UI.
-
-To make use of Payload SCSS variables / mixins to use directly in your own components, you can import them as follows:
-
-```
-@import '~payload/scss';
-```
-
-### Getting the current language
-
-When developing custom components you can support multiple languages to be consistent with Payload's i18n support. The best way to do this is to add your translation resources to the [i18n configuration](https://payloadcms.com/docs/configuration/i18n) and import `useTranslation` from `react-i18next` in your components.
-
-For example:
-
-```tsx
-import { useTranslation } from 'react-i18next'
-
-const CustomComponent: React.FC = () => {
-  // highlight-start
-  const { t, i18n } = useTranslation('namespace1')
-  // highlight-end
-
-  return (
-    <ul>
-      <li>{t('key', { variable: 'value' })}</li>
-      <li>{t('namespace2:key', { variable: 'value' })}</li>
-      <li>{i18n.language}</li>
-    </ul>
-  )
-}
-```
-
-### Getting the current locale
-
-In any custom component you can get the selected locale with `useLocale` hook. `useLocale` returns the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
-
-```tsx
-import { useLocale } from 'payload/components/utilities'
-
-const Greeting: React.FC = () => {
-  // highlight-start
-  const locale = useLocale()
-  // highlight-end
-
-  const trans = {
-    en: 'Hello',
-    es: 'Hola',
-  }
-
-  return <span> {trans[locale.code]} </span>
-}
-```

docs/admin/customizing-css.mdx

@@ -1,51 +0,0 @@
----
-title: Customizing CSS & SCSS
-label: Customizing CSS
-order: 40
-desc: Customize your Payload admin panel further by adding your own CSS or SCSS style sheet to the configuration, powerful theme and design options are waiting for you.
-keywords: admin, css, scss, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-### Adding your own CSS / SCSS
-
-You can add your own CSS by providing your base Payload config with a path to your own CSS or SCSS. Customize the styling of any part of the Payload dashboard as necessary.
-
-To do so, provide your base Payload config with a path to your own stylesheet. It can be either a CSS or SCSS file.
-
-**Example in payload.config.js:**
-
-```ts
-import { buildConfig } from 'payload/config'
-import path from 'path'
-
-const config = buildConfig({
-  admin: {
-    css: path.resolve(__dirname, 'relative/path/to/stylesheet.scss'),
-  },
-})
-```
-
-### Overriding built-in styles
-
-To make it as easy as possible for you to override our styles, Payload uses [BEM naming conventions](http://getbem.com/) for all CSS within the Admin UI. If you provide your own CSS, you can override any built-in styles easily.
-
-In addition to adding your own style definitions, you can also override Payload's built-in CSS variables. We use as much as possible behind the scenes, and you can override any of them that you'd like to.
-
-You can find the built-in Payload CSS variables within [`./src/admin/scss/app.scss`](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/scss/app.scss) and [`./src/admin/scss/colors.scss`](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/scss/colors.scss). The following variables are defined and can be overridden:
-
-- Breakpoints
-- Base color shades (white to black by default)
-- Success / warning / error color shades
-- Theme-specific colors (background, input background, text color, etc.)
-- Elevation colors (used to determine how "bright" something should be when compared to the background)
-- Fonts
-- Horizontal gutter
-
-#### Dark mode
-
-<Banner type="warning">
-  If you're overriding colors or theme elevations, make sure to consider how your changes will
-  affect dark mode.
-</Banner>
-
-By default, Payload automatically overrides all `--theme-elevation`s and inverts all success / warning / error shades to suit dark mode. We also update some base theme variables like `--theme-bg`, `--theme-text`, etc.

docs/admin/environment-vars.mdx

@@ -1,27 +0,0 @@
----
-title: Environment Variables in Admin UI
-label: Environment Variables
-order: 100
-desc: NEEDS TO BE WRITTEN
----
-
-## Admin environment vars
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  Be careful about what variables you provide to your client-side code. Analyze every single one to
-  make sure that you're not accidentally leaking anything that an attacker could exploit. Only keys
-  that are safe for anyone to read in plain text should be provided to your Admin panel.
-</Banner>
-
-By default, `env` variables are **not** provided to the Admin panel for security and safety reasons.
-But, Payload provides you with a way to still provide `env` vars to your frontend code.
-
-**Payload will automatically supply any present `env` variables that are prefixed with `PAYLOAD_PUBLIC_` directly to the Admin panel.**
-
-For example, if you've got the following environment variable:
-
-`PAYLOAD_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXX`
-
-This key will automatically be made available to the Payload bundle and can be referenced in your Admin component code as `process.env.PAYLOAD_PUBLIC_STRIPE_PUBLISHABLE_KEY`.

docs/admin/excluding-server-code.mdx

@@ -1,206 +0,0 @@
----
-title: Excluding server-only code from admin UI
-label: Excluding server code
-order: 70
-desc: Learn how to exclude server-only code from the Payload Admin UI bundle
----
-
-Because the Admin Panel browser bundle includes your Payload Config file, files using server-only modules need to be excluded.
-It's common for your config to rely on server only modules to perform logic in access control functions, hooks, and other contexts.
-
-Any file that imports a server-only module such as `fs`, `stripe`, `authorizenet`, `nodemailer`, etc. **cannot** be included in the browser bundle.
-
-#### Example Scenario
-
-Say we have a collection called `Subscriptions` that has a `beforeChange` hook that creates a Stripe subscription whenever a Subscription document is created in Payload.
-
-**Collection config**:
-
-```ts
-// collections/Subscriptions/index.ts
-
-import { CollectionConfig } from 'payload/types'
-import createStripeSubscription from './hooks/createStripeSubscription'
-
-export const Subscription: CollectionConfig = {
-  slug: 'subscriptions',
-  hooks: {
-    beforeChange: [createStripeSubscription],
-  },
-  fields: [
-    {
-      name: 'stripeSubscriptionID',
-      type: 'text',
-      required: true,
-    },
-  ],
-}
-```
-
-**Collection hook**:
-
-```ts
-// collections/Subscriptions/hooks/createStripeSubscription.ts
-
-// highlight-start
-import Stripe from 'stripe' // <-- server-only module
-// highlight-end
-
-const stripe = new Stripe(process.env.STRIPE_SECRET_KEY)
-
-export const createStripeSubscription = async ({ data, operation }) => {
-  if (operation === 'create') {
-    const dataWithStripeID = { ...data }
-
-    // use Stripe to create a Stripe subscription
-    const subscription = await stripe.subscriptions.create({
-      // Configure the subscription accordingly
-    })
-
-    // Automatically add the Stripe subscription ID
-    // to the data that will be saved to this Subscription doc
-    dataWithStripeID.stripeSubscriptionID = subscription.id
-
-    return dataWithStripeID
-  }
-
-  return data
-}
-```
-
-<Banner type="error">
-  <strong>Warning:</strong>
-  <br />
-  The above code is NOT production-ready and should not be referenced to create Stripe
-  subscriptions. Although creating a beforeChange hook is a completely valid spot to do things like
-  create subscriptions, the code above is incomplete and insecure, meant for explanation purposes
-  only.
-</Banner>
-
-**As-is, this collection will prevent your Admin panel from bundling or loading correctly, because Stripe relies on some Node-only packages.**
-
-#### How to fix this
-
-You need to make sure that you use `alias`es to tell your bundler to import "safe" files vs. attempting to import any server-side code that you need to get rid of. Depending on your bundler (Webpack, Vite, etc.) the steps involved may be slightly different.
-
-The basic idea is to create a file that exports an empty object, and then alias import paths of any files that import server-only modules to that empty object file.
-
-This way when your bundler goes to import a file that contains server-only modules, it will instead import the empty object file, which will not break the browser bundle.
-
-### Aliasing server-only modules
-
-To remove files that contain server-only modules from your bundle, you can use an `alias`.
-
-In the Subscriptions config file above, we are importing the hook like so:
-
-```ts
-// collections/Subscriptions/index.ts
-
-import createStripeSubscription from './hooks/createStripeSubscription'
-```
-
-By default the browser bundle will now include all the code from that file and any files down the tree. We know that the file imports `stripe`.
-
-To fix this, we need to alias the `createStripeSubscription` file to a different file that can safely be included in the browser bundle.
-
-First, we will create a mock file to replace the server-only file when bundling:
-```js
-// mocks/modules.js
-
-export default {}
-
-/**
- * NOTE: if you are destructuring an import
- * the mock file will need to export matching
- * variables as the destructured object.
- *
- * export const namedExport = {}
- */
-```
-
-Aliasing with [Webpack](/docs/admin/webpack) can be done by:
-
-```ts
-// payload.config.ts
-
-import { buildConfig } from 'payload/config'
-import { webpackBundler } from '@payloadcms/bundler-webpack'
-
-import { Subscriptions } from './collections/Subscriptions'
-
-const mockModulePath = path.resolve(__dirname, 'mocks/emptyObject.js')
-const fullFilePath = path.resolve(
-  __dirname,
-  'collections/Subscriptions/hooks/createStripeSubscription'
-)
-
-export default buildConfig({
-  collections: [Subscriptions],
-  admin: {
-    bundler: webpackBundler(),
-    webpack: (config) => {
-      return {
-        ...config,
-        resolve: {
-          ...config.resolve,
-          // highlight-start
-          alias: {
-            ...config.resolve.alias,
-            [fullFilePath]: mockModulePath,
-          },
-          // highlight-end
-        },
-      }
-    },
-  },
-})
-```
-
-Aliasing with [Vite](/docs/admin/vite) can be done by:
-
-```ts
-// payload.config.ts
-
-import { buildConfig } from 'payload/config'
-import { viteBundler } from '@payloadcms/bundler-vite'
-
-import { Subscriptions } from './collections/Subscriptions'
-
-const mockModulePath = path.resolve(__dirname, 'mocks/emptyObject.js')
-
-export default buildConfig({
-  collections: [Subscriptions],
-  admin: {
-    bundler: viteBundler(),
-    vite: (incomingViteConfig) => {
-      const existingAliases = incomingViteConfig?.resolve?.alias || {};
-      let aliasArray: { find: string | RegExp; replacement: string; }[] = [];
-
-      // Pass the existing Vite aliases
-      if (Array.isArray(existingAliases)) {
-        aliasArray = existingAliases;
-      } else {
-        aliasArray = Object.values(existingAliases);
-      }
-
-
-      // highlight-start
-      // Add your own aliases using the find and replacement keys
-      // remember, vite aliases are exact-match only
-      aliasArray.push({
-        find: '../server-only-module',
-        replacement: path.resolve(__dirname, './path/to/browser-safe-module.js')
-      });
-      // highlight-end
-
-      return {
-        ...incomingViteConfig,
-        resolve: {
-          ...(incomingViteConfig?.resolve || {}),
-          alias: aliasArray,
-        }
-      };
-    },
-  },
-})
-```

docs/admin/hooks.mdx

@@ -1,873 +0,0 @@
----
-title: React Hooks
-label: React Hooks
-order: 30
-desc: Make use of all of the powerful React hooks that Payload provides.
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload provides a variety of powerful hooks that can be used within your own React components. With them, you can interface with Payload itself and build just about any type of complex customization you can think of—directly in familiar React code.
-
-### useField
-
-The `useField` hook is used internally within every applicable Payload field component, and it manages sending and receiving a field's state from its parent form.
-
-Outside of internal use, its most common use-case is in custom `Field` components. When you build a custom React `Field` component, you'll be responsible for sending and receiving the field's `value` from the form itself. To do so, import the `useField` hook as follows:
-
-```tsx
-import { useField } from 'payload/components/forms'
-
-type Props = { path: string }
-
-const CustomTextField: React.FC<Props> = ({ path }) => {
-  // highlight-start
-  const { value, setValue } = useField<string>({ path })
-  // highlight-end
-
-  return <input onChange={(e) => setValue(e.target.value)} value={value.path} />
-}
-```
-
-The `useField` hook accepts an `args` object and sends back information and helpers for you to make use of:
-
-```ts
-const field = useField<string>({
-  path: 'fieldPathHere', // required
-  validate: myValidateFunc, // optional
-  disableFormData?: false, // if true, the field's data will be ignored
-  condition?: myConditionHere, // optional, used to skip validation if condition fails
-})
-
-// Here is what `useField` sends back
-const {
-  showError, // whether or not the field should show as errored
-  errorMessage, // the error message to show, if showError
-  value, // the current value of the field from the form
-  formSubmitted, // if the form has been submitted
-  formProcessing, // if the form is currently processing
-  setValue, // method to set the field's value in form state
-  initialValue, // the initial value that the field mounted with
-} = field;
-
-// The rest of your component goes here
-```
-
-### 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.
-
-<Banner type="success">
-  <strong>This hook is great for retrieving only certain fields from form state</strong> because it
-  ensures that it will only cause a rerender when the items that you ask for change.
-</Banner>
-
-Thanks to the awesome package [`use-context-selector`](https://github.com/dai-shi/use-context-selector), you can retrieve a specific field's state easily. This is ideal because you can ensure you have an up-to-date field state, and your component will only re-render when _that field's state_ changes.
-
-You can pass a Redux-like selector into the hook, which will ensure that you retrieve only the field that you want. The selector takes an argument with type of `[fields: Fields, dispatch: React.Dispatch<Action>]]`.
-
-```tsx
-import { useFormFields } from 'payload/components/forms'
-
-const MyComponent: React.FC = () => {
-  // Get only the `amount` field state, and only cause a rerender when that field changes
-  const amount = useFormFields(([fields, dispatch]) => fields.amount)
-
-  // Do the same thing as above, but to the `feePercentage` field
-  const feePercentage = useFormFields(([fields, dispatch]) => fields.feePercentage)
-
-  if (typeof amount?.value !== 'undefined' && typeof feePercentage?.value !== 'undefined') {
-    return <span>The fee is ${(amount.value * feePercentage.value) / 100}</span>
-  }
-}
-```
-
-### useAllFormFields
-
-**To retrieve more than one field**, you can use the `useAllFormFields` hook. Your component will re-render when _any_ field changes, so use this hook only if you absolutely need to. Unlike the `useFormFields` hook, this hook does not accept a "selector", and it always returns an array with type of `[fields: Fields, dispatch: React.Dispatch<Action>]]`.
-
-You can do lots of powerful stuff by retrieving the full form state, like using built-in helper functions to reduce field state to values only, or to retrieve sibling data by path.
-
-```tsx
-import { useAllFormFields, reduceFieldsToValues, getSiblingData } from 'payload/components/forms';
-
-const ExampleComponent: React.FC = () => {
-  // the `fields` const will be equal to all fields' state,
-  // and the `dispatchFields` method is usable to send field state up to the form
-  const [fields, dispatchFields] = useAllFormFields();
-
-  // Pass in fields, and indicate if you'd like to "unflatten" field data.
-  // The result below will reflect the data stored in the form at the given time
-  const formData = reduceFieldsToValues(fields, true);
-
-  // Pass in field state and a path,
-  // and you will be sent all sibling data of the path that you've specified
-  const siblingData = getSiblingData(fields, 'someFieldName');
-
-  return (
-    // return some JSX here if necessary
-  )
-};
-```
-
-##### Updating other fields' values
-
-If you are building a custom component, then you should use `setValue` which is returned from the `useField` hook to programmatically set your field's value. But if you're looking to update _another_ field's value, you can use `dispatchFields` returned from `useFormFields`.
-
-You can send the following actions to the `dispatchFields` function.
-
-| Action                 | Description                                                                |
-| ---------------------- | -------------------------------------------------------------------------- |
-| **`ADD_ROW`**          | Adds a row of data (useful in array / block field data)                    |
-| **`DUPLICATE_ROW`**    | Duplicates a row of data (useful in array / block field data)              |
-| **`MODIFY_CONDITION`** | Updates a field's conditional logic result (true / false)                  |
-| **`MOVE_ROW`**         | Moves a row of data (useful in array / block field data)                   |
-| **`REMOVE`**           | Removes a field from form state                                            |
-| **`REMOVE_ROW`**       | Removes a row of data from form state (useful in array / block field data) |
-| **`REPLACE_STATE`**    | Completely replaces form state                                             |
-| **`UPDATE`**           | Update any property of a specific field's state                            |
-
-To see types for each action supported within the `dispatchFields` hook, check out the Form types [here](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/components/forms/Form/types.ts).
-
-### useForm
-
-The `useForm` hook can be used to interact with the form itself, and sends back many methods that can be used to reactively fetch form state without causing rerenders within your components each time a field is changed. This is useful if you have action-based callbacks that your components fire, and need to interact with form state _based on a user action_.
-
-<Banner type="warning">
-  <strong>Warning:</strong>
-  <br />
-  This hook is optimized to avoid causing rerenders when fields change, and as such, its `fields`
-  property will be out of date. You should only leverage this hook if you need to perform actions
-  against the form in response to your users' actions. Do not rely on its returned "fields" as being
-  up-to-date. They will be removed from this hook's response in an upcoming version.
-</Banner>
-
-The `useForm` hook returns an object with the following properties: |
-
-<TableWithDrawers
-  columns={[
-    'Action',
-    'Description',
-    'Example',
-  ]}
-  rows={[
-    [
-      {
-        value: <strong><code>fields</code></strong>,
-      },
-      {
-        value: "Deprecated. This property cannot be relied on as up-to-date.",
-      },
-      {
-        value: ''
-      }
-    ],
-    [
-      {
-        value: <strong><code>submit</code></strong>,
-      },
-      {
-        value: "Method to trigger the form to submit",
-      },
-      {
-        value: ''
-      }
-    ],
-    [
-      {
-        value: <strong><code>dispatchFields</code></strong>,
-      },
-      {
-        value: "Dispatch actions to the form field state",
-      },
-      {
-        value: ''
-      }
-    ],
-    [
-      {
-        value: <strong><code>validateForm</code></strong>,
-      },
-      {
-        value: "Trigger a validation of the form state",
-      },
-      {
-        value: ''
-      }
-    ],
-    [
-      {
-        value: <strong><code>createFormData</code></strong>,
-      },
-      {
-        value: <>Create a <code>multipart/form-data</code> object from the current form's state</>,
-      },
-      {
-        value: ''
-      }
-    ],
-    [
-      {
-        value: <strong><code>disabled</code></strong>,
-      },
-      {
-        value: "Boolean denoting whether or not the form is disabled",
-      },
-      {
-        value: ''
-      }
-    ],
-    [
-      {
-        value: <strong><code>getFields</code></strong>,
-      },
-      {
-        value: 'Gets all fields from state',
-      },
-      {
-        value: '',
-      }
-    ],
-    [
-      {
-        value: <strong><code>getField</code></strong>,
-      },
-      {
-        value: 'Gets a single field from state by path',
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>getData</code></strong>,
-      },
-      {
-        value: 'Returns the data stored in the form',
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>getSiblingData</code></strong>,
-      },
-      {
-        value: 'Returns form sibling data for the given field path',
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>setModified</code></strong>,
-      },
-      {
-        value: <>Set the form\'s <code>modified</code> state</>,
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>setProcessing</code></strong>,
-      },
-      {
-        value: <>Set the form\'s <code>processing</code> state</>,
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>setSubmitted</code></strong>,
-      },
-      {
-        value: <>Set the form\'s <code>submitted</code> state</>,
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>formRef</code></strong>,
-      },
-      {
-        value: 'The ref from the form HTML element',
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>reset</code></strong>,
-      },
-      {
-        value: 'Method to reset the form to its initial state',
-      },
-      {
-        value: '',
-      },
-    ],
-    [
-      {
-        value: <strong><code>addFieldRow</code></strong>,
-      },
-      {
-        value: "Method to add a row on an array or block field",
-      },
-      {
-        drawerTitle: 'addFieldRow',
-        drawerDescription: 'A useful method to programmatically add a row to an array or block field.',
-        drawerSlug: 'addFieldRow',
-        drawerContent: (
-<>
-  <TableWithDrawers
-    columns={[
-      'Prop',
-      'Description',
-    ]}
-    rows={[
-      [
-        {
-          value: <strong><code>path</code></strong>,
-        },
-        {
-          value: "The path to the array or block field",
-        },
-      ],
-      [
-        {
-          value: <strong><code>rowIndex</code></strong>,
-        },
-        {
-          value: "The index of the row to add. If omitted, the row will be added to the end of the array.",
-        },
-      ],
-      [
-        {
-          value: <strong><code>data</code></strong>,
-        },
-        {
-          value: "The data to add to the row",
-        },
-      ],
-    ]}
-  />
-
-{' '}
-
-<br />
-
-{' '}
-
-<pre>
-  {`import { useForm } from "payload/components/forms";
-
-export const CustomArrayManager = () => {
-  const { addFieldRow } = useForm()
-
-  return (
-    <button
-      type="button"
-      onClick={() => {
-        addFieldRow({
-          path: "arrayField",
-          rowIndex: 0,
-          data: {
-            textField: "text",
-            // blockType: "yourBlockSlug",
-            // ^ if managing a block array, you need to specify the block type
-          },
-        })
-      }}
-    >
-      Add Row
-    </button>
-  )
-}`}
-</pre>
-
-  <p>An example config to go along with the custom component</p>
-  <pre>
-{`const ExampleCollection = {
-  slug: "example-collection",
-  fields: [
-    {
-      name: "arrayField",
-      type: "array",
-      fields: [
-        {
-          name: "textField",
-          type: "text",
-        },
-      ],
-    },
-    {
-      type: "ui",
-      name: "customArrayManager",
-      admin: {
-        components: {
-          Field: CustomArrayManager,
-        },
-      },
-    },
-  ],
-}`}
-  </pre>
-</>
-        )
-      }
-    ],
-    [
-      {
-        value: <strong><code>removeFieldRow</code></strong>,
-      },
-      {
-        value: "Method to remove a row from an array or block field",
-      },
-      {
-        drawerTitle: 'removeFieldRow',
-        drawerDescription: 'A useful method to programmatically remove a row from an array or block field.',
-        drawerSlug: 'removeFieldRow',
-        drawerContent: (
-<>
-  <TableWithDrawers
-    columns={[
-      'Prop',
-      'Description',
-    ]}
-    rows={[
-      [
-        {
-          value: <strong><code>path</code></strong>,
-        },
-        {
-          value: "The path to the array or block field",
-        },
-      ],
-      [
-        {
-          value: <strong><code>rowIndex</code></strong>,
-        },
-        {
-          value: "The index of the row to remove",
-        },
-      ],
-    ]}
-  />
-
-{' '}
-
-<br />
-
-{' '}
-
-<pre>
-  {`import { useForm } from "payload/components/forms";
-
-export const CustomArrayManager = () => {
-  const { removeFieldRow } = useForm()
-
-  return (
-    <button
-      type="button"
-      onClick={() => {
-        removeFieldRow({
-          path: "arrayField",
-          rowIndex: 0,
-        })
-      }}
-    >
-      Remove Row
-    </button>
-  )
-}`}
-</pre>
-
-  <p>An example config to go along with the custom component</p>
-  <pre>
-{`const ExampleCollection = {
-  slug: "example-collection",
-  fields: [
-    {
-      name: "arrayField",
-      type: "array",
-      fields: [
-        {
-          name: "textField",
-          type: "text",
-        },
-      ],
-    },
-    {
-      type: "ui",
-      name: "customArrayManager",
-      admin: {
-        components: {
-          Field: CustomArrayManager,
-        },
-      },
-    },
-  ],
-}`}
-  </pre>
-</>
-        )
-      }
-    ],
-    [
-      {
-        value: <strong><code>replaceFieldRow</code></strong>,
-      },
-      {
-        value: "Method to replace a row from an array or block field",
-      },
-      {
-        drawerTitle: 'replaceFieldRow',
-        drawerDescription: 'A useful method to programmatically replace a row from an array or block field.',
-        drawerSlug: 'replaceFieldRow',
-        drawerContent: (
-<>
-  <TableWithDrawers
-    columns={[
-      'Prop',
-      'Description',
-    ]}
-    rows={[
-      [
-        {
-          value: <strong><code>path</code></strong>,
-        },
-        {
-          value: "The path to the array or block field",
-        },
-      ],
-      [
-        {
-          value: <strong><code>rowIndex</code></strong>,
-        },
-        {
-          value: "The index of the row to replace",
-        },
-      ],
-      [
-        {
-          value: <strong><code>data</code></strong>,
-        },
-        {
-          value: "The data to replace within the row",
-        },
-      ],
-    ]}
-  />
-
-{' '}
-
-<br />
-
-{' '}
-
-<pre>
-  {`import { useForm } from "payload/components/forms";
-
-export const CustomArrayManager = () => {
-  const { replaceFieldRow } = useForm()
-
-  return (
-    <button
-      type="button"
-      onClick={() => {
-        replaceFieldRow({
-          path: "arrayField",
-          rowIndex: 0,
-          data: {
-            textField: "updated text",
-            // blockType: "yourBlockSlug",
-            // ^ if managing a block array, you need to specify the block type
-          },
-        })
-      }}
-    >
-      Replace Row
-    </button>
-  )
-}`}
-</pre>
-
-  <p>An example config to go along with the custom component</p>
-  <pre>
-{`const ExampleCollection = {
-  slug: "example-collection",
-  fields: [
-    {
-      name: "arrayField",
-      type: "array",
-      fields: [
-        {
-          name: "textField",
-          type: "text",
-        },
-      ],
-    },
-    {
-      type: "ui",
-      name: "customArrayManager",
-      admin: {
-        components: {
-          Field: CustomArrayManager,
-        },
-      },
-    },
-  ],
-}`}
-  </pre>
-</>
-        )
-      }
-    ],
-  ]}
-/>
-
-### useCollapsible
-
-The `useCollapsible` hook allows you to control parent collapsibles:
-
-| Property                  | Description                                                                                                        |
-|---------------------------|--------------------------------------------------------------------------------------------------------------------|
-| **`collapsed`**          | State of the collapsible. `true` if open, `false` if collapsed                                                 |
-| **`isVisible`**              | If nested, determine if the nearest collapsible is visible. `true` if no parent is closed, `false` otherwise                                                        |
-| **`toggle`**                  | Toggles the state of the nearest collapsible                                                                |
-| **`withinCollapsible`**      | Determine when you are within another collaspible                                 |                                               |
-
-**Example:**
-
-```tsx
-import React from 'react'
-
-import { useCollapsible } from 'payload/components/utilities'
-
-const CustomComponent: React.FC = () => {
-  const { collapsed, toggle } = useCollapsible()
-  return (
-    <div>
-      <p className="field-type">I am {collapsed ? 'closed' : 'open'}</p>
-      <button onClick={toggle} type="button">
-        Toggle
-      </button>
-    </div>
-  )
-}
-```
-
-### useDocumentInfo
-
-The `useDocumentInfo` hook provides lots of information about the document currently being edited, including the following:
-
-| Property                  | Description                                                                                                        |
-|---------------------------|--------------------------------------------------------------------------------------------------------------------|
-| **`collection`**          | If the doc is a collection, its collection config will be returned                                                 |
-| **`global`**              | If the doc is a global, its global config will be returned                                                         |
-| **`id`**                  | If the doc is a collection, its ID will be returned                                                                |
-| **`preferencesKey`**      | The `preferences` key to use when interacting with document-level user preferences                                 |
-| **`versions`**            | Versions of the current doc                                                                                        |
-| **`unpublishedVersions`** | Unpublished versions of the current doc                                                                            |
-| **`publishedDoc`**        | The currently published version of the doc being edited                                                            |
-| **`getVersions`**         | Method to trigger the retrieval of document versions                                                               |
-| **`docPermissions`**      | The current documents permissions. Collection document permissions fallback when no id is present (i.e. on create) |
-| **`getDocPermissions`**   | Method to trigger the retrieval of document level permissions                                                      |
-
-**Example:**
-
-```tsx
-import { useDocumentInfo } from 'payload/components/utilities'
-
-const LinkFromCategoryToPosts: React.FC = () => {
-  // highlight-start
-  const { id } = useDocumentInfo()
-  // highlight-end
-
-  // id will be undefined on the create form
-  if (!id) {
-    return null
-  }
-
-  return (
-    <a href={`/admin/collections/posts?where[or][0][and][0][category][in][0]=[${id}]`}>
-      View posts
-    </a>
-  )
-}
-```
-
-### 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:
-
-```tsx
-import { useLocale } from 'payload/components/utilities'
-
-const Greeting: React.FC = () => {
-  // highlight-start
-  const locale = useLocale()
-  // highlight-end
-
-  const trans = {
-    en: 'Hello',
-    es: 'Hola',
-  }
-
-  return <span> {trans[locale.code]} </span>
-}
-```
-
-### useAuth
-
-Useful to retrieve info about the currently logged in user as well as methods for interacting with it. It sends back an object with the following properties:
-
-| Property                 | Description                                                                             |
-| ------------------------ | --------------------------------------------------------------------------------------- |
-| **`user`**               | The currently logged in user                                                            |
-| **`logOut`**             | A method to log out the currently logged in user                                        |
-| **`refreshCookie`**      | A method to trigger the silent refreshing of a user's auth token                        |
-| **`setToken`**           | Set the token of the user, to be decoded and used to reset the user and token in memory |
-| **`token`**              | The logged in user's token (useful for creating preview links, etc.)                    |
-| **`refreshPermissions`** | Load new permissions (useful when content that effects permissions has been changed)    |
-| **`permissions`**        | The permissions of the current user                                                     |
-
-```tsx
-import { useAuth } from 'payload/components/utilities'
-import { User } from '../payload-types.ts'
-
-const Greeting: React.FC = () => {
-  // highlight-start
-  const { user } = useAuth<User>()
-  // highlight-end
-
-  return <span>Hi, {user.email}!</span>
-}
-```
-
-### useConfig
-
-Used to easily fetch the full Payload config.
-
-```tsx
-import { useConfig } from 'payload/components/utilities'
-
-const MyComponent: React.FC = () => {
-  // highlight-start
-  const config = useConfig()
-  // highlight-end
-
-  return <span>{config.serverURL}</span>
-}
-```
-
-### useEditDepth
-
-Sends back how many editing levels "deep" the current component is. Edit depth is relevant while adding new documents / editing documents in modal windows and other cases.
-
-```tsx
-import { useEditDepth } from 'payload/components/utilities'
-
-const MyComponent: React.FC = () => {
-  // highlight-start
-  const editDepth = useEditDepth()
-  // highlight-end
-
-  return <span>My component is {editDepth} levels deep</span>
-}
-```
-
-### usePreferences
-
-Returns methods to set and get user preferences. More info can be found [here](https://payloadcms.com/docs/admin/preferences).
-
-### useTheme
-
-Returns the currently selected theme (`light`, `dark` or `auto`), a set function to update it and a boolean `autoMode`, used to determine if the theme value should be set automatically based on the user's device preferences.
-
-```tsx
-import { useTheme } from 'payload/components/utilities'
-
-const MyComponent: React.FC = () => {
-  // highlight-start
-  const { autoMode, setTheme, theme } = useTheme()
-  // highlight-end
-
-  return (
-    <>
-      <span>The current theme is {theme} and autoMode is {autoMode}</span>
-      <button
-        type="button"
-        onClick={() => setTheme(prev => prev === "light" ? "dark" : "light")}
-      >
-        Toggle theme
-      </button>
-    </>
-    )
-}
-```
-
-### useTableColumns
-
-Returns methods to manipulate table columns
-
-```tsx
-import { useTableColumns } from 'payload/components/hooks'
-
-const MyComponent: React.FC = () => {
-  // highlight-start
-  const { setActiveColumns } = useTableColumns()
-
-  const resetColumns = () => {
-    setActiveColumns(['id', 'createdAt', 'updatedAt'])
-  }
-  // highlight-end
-
-  return (
-    <button
-      type="button"
-      onClick={resetColumns}
-    >
-      Reset columns
-    </button>
-  )
-}
-```
-
-### 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:
-
-| Property                  | Description                                                                                                                               |
-|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
-| **`mostRecentUpdate`**    | An object containing the most recently updated document. It contains the `entitySlug`, `id` (if collection), and `updatedAt` properties   |
-| **`reportUpdate`**        | A method used to report updates to documents. It accepts the same arguments as the `mostRecentUpdate` property.                           |
-
-**Example:**
-
-```tsx
-import { useDocumentEvents } from 'payload/components/hooks'
-
-const ListenForUpdates: React.FC = () => {
-  const { mostRecentUpdate } = useDocumentEvents()
-
-  return (
-    <span>
-      {JSON.stringify(mostRecentUpdate)}
-    </span>
-  )
-}
-```
-
-<Banner type="info">
-  Right now the `useDocumentEvents` hook only tracks recently updated documents, but in the future it will track more document-related events as needed, such as document creation, deletion, etc.
-</Banner>

docs/admin/overview.mdx

@@ -1,91 +0,0 @@
----
-title: The Admin Panel
-label: Overview
-order: 10
-desc: Manage your data and customize the Admin Panel by swapping in your own React components. Create, modify or remove views, fields, styles and much more.
-keywords: admin, components, custom, customize, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload dynamically generates a beautiful, fully functional React admin panel to manage your data. It's extremely powerful and can be customized / extended upon easily by swapping in your own React components. You can add additional views, modify how built-in views look / work, swap out Payload branding for your client's, build your own field types and much more.
-
-The Payload Admin panel can be bundled with our officially supported [Vite](/docs/admin/vite) and [webpack](/docs/admin/webpack) bundlers or you can integrate another bundler following our adapter pattern approach.
-When bundled, it is code-split, highly performant (even with 100+ fields), and written fully in TypeScript.
-
-<Banner type="success">
-  The Admin panel is meant to be simple enough to give you a starting point but not bring too much
-  complexity, so that you can easily customize it to suit the needs of your application and your
-  editors.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/admin.jpg"
-  srcDark="https://payloadcms.com/images/docs/admin-dark.jpg"
-  alt="Admin panel with collapsible sidebar"
-  caption="Redesigned admin panel with a collapsible sidebar that's open by default, providing greater extensibility and enhanced horizontal real estate."
-/>
-
-## Admin Options
-
-All options for the Admin panel are defined in your base Payload config file.
-
-| Option            | Description                                                                                                                                                                                                                                                                 |
-| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `bundler`         | The bundler that you would like to use to bundle the admin panel. Officially supported bundlers: [Webpack](/docs/admin/webpack) and [Vite](/docs/admin/vite).                                                                                                               |
-| `user`            | The `slug` of a Collection that you want be used to log in to the Admin dashboard. [More](/docs/admin/overview#the-admin-user-collection)                                                                                                                                   |
-| `buildPath`       | Specify an absolute path for where to store the built Admin panel bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                                                                                                                            |
-| `meta`            | Base meta data to use for the Admin panel. Included properties are `titleSuffix`, `ogImage`, and `favicon`.                                                                                                                                                                 |
-| `disable`         | If set to `true`, the entire Admin panel will be disabled.                                                                                                                                                                                                                  |
-| `indexHTML`       | Optionally replace the entirety of the `index.html` file used by the Admin panel. Reference the [base index.html file](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/index.html) to ensure your replacement has the appropriate HTML elements. |
-| `css`             | Absolute path to a stylesheet that you can use to override / customize the Admin panel styling. [More](/docs/admin/customizing-css).                                                                                                                                        |
-| `scss`            | Absolute path to a Sass variables / mixins stylesheet meant to override Payload styles to make for an easy re-skinning of the Admin panel. [More](/docs/admin/customizing-css#overriding-scss-variables).                                                                   |
-| `dateFormat`      | Global date format that will be used for all dates in the Admin panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                                                                                                                              |
-| `avatar`          | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                                                                                                                                    |
-| `autoLogin`       | Used to automate admin log-in for dev and demonstration convenience. [More](/docs/authentication/config).                                                                                                                                                                   |
-| `livePreview`     | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).                                                                                                                                                    |
-| `components`      | Component overrides that affect the entirety of the Admin panel. [More](/docs/admin/components)                                                                                                                                                                             |
-| `webpack`         | Customize the Webpack config that's used to generate the Admin panel. [More](/docs/admin/webpack)                                                                                                                                                                           |
-| `vite`            | Customize the Vite config that's used to generate the Admin panel. [More](/docs/admin/vite)                                                                                                                                                                                 |
-| `logoutRoute`     | The route for the `logout` page.                                                                                                                                                                                                                                            |
-| `inactivityRoute` | The route for the `logout` inactivity page.                                                                                                                                                                                                                                 |
-
-### The Admin User Collection
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  The Payload Admin panel can only be used by one Collection that supports
-  [Authentication](/docs/authentication/overview).
-</Banner>
-
-To specify which Collection to use to log in to the Admin panel, pass the `admin` options a `user` key equal to the slug of the Collection that you'd like to use.
-
-`payload.config.js`:
-
-```ts
-import { buildConfig } from 'payload/config'
-
-const config = buildConfig({
-  admin: {
-    user: 'admins', // highlight-line
-  },
-})
-```
-
-By default, if you have not specified a Collection, Payload will automatically provide you with a `User` Collection which will be used to access the Admin panel. You can customize or override the fields and settings of the default `User` Collection by passing your own collection using `users` as its `slug` to Payload. When this is done, Payload will use your provided `User` Collection instead of its default version.
-
-**Note: you can use whatever Collection you'd like to access the Admin panel as long as the Collection supports Authentication. It doesn't need to be called `users`!**
-
-For example, you may wish to have two Collections that both support `Authentication`:
-
-- `admins` - meant to have a higher level of permissions to manage your data and access the Admin panel
-- `customers` - meant for end users of your app that should not be allowed to log into the Admin panel
-
-This is totally possible. For the above scenario, by specifying `admin: { user: 'admins' }`, your Payload Admin panel will use `admins`. Any users logged in as `customers` will not be able to log in via the Admin panel.
-
-### Light and dark modes
-
-Users in the admin panel have access to choosing between light mode and dark mode for their editing experience. The setting is managed while logged into the admin UI within the user account page and will be stored with the browser. By default, the operating system preference is detected and used.
-
-### Restricting user access
-
-If you would like to restrict which users from a single Collection can access the Admin panel, you can use the `admin` access control function. [Click here](/docs/access-control/overview#admin) to learn more.

docs/admin/preferences.mdx

@@ -1,159 +0,0 @@
----
-title: Managing User Preferences
-label: Preferences
-order: 50
-desc: Store the preferences of your users as they interact with the Admin panel.
-keywords: admin, preferences, custom, customize, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-As your users interact with your Admin panel, you might want to store their preferences in a persistent manner, so that when they revisit the Admin panel, they can pick right back up where they left off.
-
-Out of the box, Payload handles the persistence of your users' preferences in a handful of ways, including:
-
-1. Collection `List` view active columns, and their order, that users define
-1. Their last active locale
-1. The "collapsed" state of blocks, on a document level, as users edit or interact with documents
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  All preferences are stored on an individual user basis. Payload automatically recognizes the user
-  that is reading or setting a preference via all provided authentication methods.
-</Banner>
-
-### Use cases
-
-This API is used significantly for internal operations of the Admin panel, as mentioned above. But, if you're building your own React components for use in the Admin panel, you can allow users to set their own preferences in correspondence to their usage of your components. For example:
-
-- If you have built a "color picker", you could "remember" the last used colors that the user has set for easy access next time
-- If you've built a custom `Nav` component, and you've built in an "accordion-style" UI, you might want to store the `collapsed` state of each Nav collapsible item. This way, if an editor returns to the panel, their `Nav` state is persisted automatically
-- You might want to store `recentlyAccessed` documents to give admin editors an easy shortcut back to their recently accessed documents on the `Dashboard` or similar
-- Many other use cases exist. Invent your own! Give your editors an intelligent and persistent editing experience.
-
-### Database
-
-Payload automatically creates an internally used `payload-preferences` collection that stores user preferences. Each document in the `payload-preferences` collection contains the following shape:
-
-| Key               | Value                                                             |
-| ----------------- | ----------------------------------------------------------------- |
-| `id`              | A unique ID for each preference stored.                           |
-| `key`             | A unique `key` that corresponds to the preference.                |
-| `user.value`      | The ID of the `user` that is storing its preference.              |
-| `user.relationTo` | The `slug` of the collection that the `user` is logged in as.     |
-| `value`           | The value of the preference. Can be any data shape that you need. |
-| `createdAt`       | A timestamp of when the preference was created.                   |
-| `updatedAt`       | A timestamp set to the last time the preference was updated.      |
-
-### APIs
-
-Preferences are available to both [GraphQL](/docs/graphql/overview#preferences) and [REST](/docs/rest-api/overview#) APIs.
-
-### Adding or reading Preferences in your own components
-
-The Payload admin panel offers a `usePreferences` hook. The hook is only meant for use within the admin panel itself. It provides you with two methods:
-
-##### `getPreference`
-
-This async method provides an easy way to retrieve a user's preferences by `key`. It will return a promise containing the resulting preference value.
-
-**Arguments**
-
-- `key`: the `key` of your preference to retrieve.
-
-##### `setPreference`
-
-Also async, this method provides you with an easy way to set a user preference. It returns `void`.
-
-**Arguments:**
-
-- `key`: the `key` of your preference to set.
-- `value`: the `value` of your preference that you're looking to set.
-
-## Example
-
-Here is an example for how you can utilize `usePreferences` within your custom Admin panel components. Note - this example is not fully useful and is more just a reference for how to utilize the Preferences API. In this case, we are demonstrating how to set and retrieve a user's last used colors history within a `ColorPicker` or similar type component.
-
-```
-import React, { Fragment, useState, useEffect, useCallback } from 'react';
-import { usePreferences } from 'payload/components/preferences';
-
-const lastUsedColorsPreferenceKey = 'last-used-colors';
-
-const CustomComponent = (props) => {
-  const { getPreference, setPreference } = usePreferences();
-
-  // Store the last used colors in local state
-  const [lastUsedColors, setLastUsedColors] = useState([]);
-
-  // Callback to add a color to the last used colors
-  const updateLastUsedColors = useCallback((color) => {
-    // First, check if color already exists in last used colors.
-    // If it already exists, there is no need to update preferences
-    const colorAlreadyExists = lastUsedColors.indexOf(color) > -1;
-
-    if (!colorAlreadyExists) {
-      const newLastUsedColors = [
-        ...lastUsedColors,
-        color,
-      ];
-
-      setLastUsedColors(newLastUsedColors);
-      setPreference(lastUsedColorsPreferenceKey, newLastUsedColors);
-    }
-  }, [lastUsedColors, setPreference]);
-
-  // Retrieve preferences on component mount
-  // This will only be run one time, because the `getPreference` method never changes
-  useEffect(() => {
-    const asyncGetPreference = async () => {
-      const lastUsedColorsFromPreferences = await getPreference(lastUsedColorsPreferenceKey);
-      setLastUsedColors(lastUsedColorsFromPreferences);
-    };
-
-    asyncGetPreference();
-  }, [getPreference]);
-
-  return (
-    <div>
-      <button
-        type="button"
-        onClick={() => updateLastUsedColors('red')}
-      >
-        Use red
-      </button>
-      <button
-        type="button"
-        onClick={() => updateLastUsedColors('blue')}
-      >
-        Use blue
-      </button>
-      <button
-        type="button"
-        onClick={() => updateLastUsedColors('purple')}
-      >
-        Use purple
-      </button>
-      <button
-        type="button"
-        onClick={() => updateLastUsedColors('yellow')}
-      >
-        Use yellow
-      </button>
-      {lastUsedColors && (
-        <Fragment>
-          <h5>Last used colors:</h5>
-          <ul>
-            {lastUsedColors?.map((color) => (
-              <li key={color}>
-                {color}
-              </li>
-            ))}
-          </ul>
-        </Fragment>
-      )}
-    </div>
-  );
-};
-
-export default CustomComponent;
-```

docs/admin/vite.mdx

@@ -1,161 +0,0 @@
----
-title: Vite
-label: Vite
-order: 90
-desc: NEEDS TO BE WRITTEN
----
-
-<Banner type="info">
-  The Vite bundler is currently in beta. If you would like to help us test this package, we'd love to hear from you if you find any [bugs or issues](https://github.com/payloadcms/payload/issues/)!
-</Banner>
-
-Payload has a Vite bundler that you can install and bundle the Admin Panel with. This is an alternative to the [Webpack](/docs/admin/webpack) bundler and might give some performance boosts to your development workflow.
-
-To use Vite as your bundler, first you need to install the package:
-
-```bash
-yarn add @payloadcms/bundler-vite
-```
-
-Then you will need to add the [bundler](/docs/admin/bundlers) to your Payload config:
-
-```ts
-import { buildConfig } from '@payloadcms/config'
-import { viteBundler } from '@payloadcms/bundler-vite'
-
-export default buildConfig({
-  collections: [],
-  admin: {
-    bundler: viteBundler(),
-  }
-})
-```
-
-Vite works fundamentally differently than Webpack. In development mode, it will first pre-bundle any of your dependencies that are CommonJS-only, and then it'll leverage ESM directly in your browser for a better HMR experience.
-
-It then uses Rollup to create production builds of your admin UI. With Vite, you should see a decent performance boost—especially after your first cold start. However, that first cold start might take a few more seconds.
-
-<Banner type="warning">
-  In most cases, Vite should work out of the box. But existing Payload plugins may need to make compatibility changes to support Vite.
-</Banner>
-
-This is because Vite aliases work fundamentally differently than Webpack aliases, and Payload relies on aliasing server-only code out of the Payload config to ensure that the bundled admin JS works within your browser.
-
-Here are the main differences between how Vite aliases work and how Webpack aliases work.
-
-**Vite aliases do not work with absolute paths.**
-
-In Vite, alias keys must <strong>exactly match</strong> a import paths. If you have 2 files that import the same server-only module, but have different import paths, you would need to add 2 aliases to support both import paths.
-
-```ts
-// File A
-import serverOnlyModule from '../server-only-module'
-
-// File B
-import serverOnlyModule from '../../server-only-module'
-
-// payload.config.ts
-// You would need to add 2 aliases to support both import paths
-export const buildConfig({
-  collections: [],
-  admin: {
-    bundler: viteBundler(),
-    vite: (incomingViteConfig) => {
-      const existingAliases = incomingViteConfig?.resolve?.alias || {};
-      let aliasArray: { find: string | RegExp; replacement: string; }[] = [];
-
-      // Pass the existing Vite aliases
-      if (Array.isArray(existingAliases)) {
-        aliasArray = existingAliases;
-      } else {
-        aliasArray = Object.values(existingAliases);
-      }
-
-      // Add your own aliases using the find and replacement keys
-      aliasArray.push({
-        find: '../server-only-module',
-        replacement: path.resolve(__dirname, './path/to/browser-safe-module.js')
-        find: '../../server-only-module',
-        replacement: path.resolve(__dirname, './path/to/browser-safe-module.js')
-      });
-
-      return {
-        ...incomingViteConfig,
-        resolve: {
-          ...(incomingViteConfig?.resolve || {}),
-          alias: aliasArray,
-        }
-      };
-    },
-  }
-})
-```
-
-**Vite aliases do not get applied to pre-bundled dependencies.**
-
-This especially affects plugins, as plugins will be pre-bundled by Vite using `esbuild`. To get around this and support Vite, plugin authors need to configure an alias to their plugin at the top level, so that the alias will work accordingly.
-
-Here's an example. Say your plugin is called `payload-plugin-cool`. It's imported as follows:
-
-```ts
-import { myCoolPlugin } from 'payload-plugin-cool'
-```
-
-That plugin should create an alias to support Vite as follows:
-
-```ts
-{
-  // aliases go here
-  find: 'payload-plugin-cool',
-  replacement: path.resolve(__dirname, './my-admin-plugin.js')
-}
-
-```
-
-This will effectively alias the entire plugin and work with Vite. If the plugin requires admin-specific code, then the `./my-admin-plugin.js` alias target file should reflect any changes necessary to the admin UI that the main server-side plugin performs.
-
-### Extending the Vite config
-
-The Payload config supports a new property for plugins to be able to extend the Vite config specifically. That property exists on the main Payload config under `admin.vite`. You can check out the [Vite docs](https://vitejs.dev/config/shared-options.html) for more information on what you can do with the Vite config.
-
-It's a function that takes a Vite config, and returns an updated Vite config. Here's an example:
-
-```ts
-export const buildConfig({
-  collections: [],
-  admin: {
-    bundler: viteBundler(),
-    vite: (incomingViteConfig) => {
-      const existingAliases = incomingViteConfig?.resolve?.alias || {};
-      let aliasArray: { find: string | RegExp; replacement: string; }[] = [];
-
-      // Pass the existing Vite aliases
-      if (Array.isArray(existingAliases)) {
-        aliasArray = existingAliases;
-      } else {
-        aliasArray = Object.values(existingAliases);
-      }
-
-      // Add your own aliases using the find and replacement keys
-      aliasArray.push({
-        find: '../server-only-module',
-        replacement: path.resolve(__dirname, './path/to/browser-safe-module.js')
-      });
-
-      return {
-        ...incomingViteConfig,
-        resolve: {
-          ...(incomingViteConfig?.resolve || {}),
-          alias: aliasArray,
-        }
-      };
-    },
-  }
-})
-```
-
-Learn more about [aliasing server-only modules](https://payloadcms.com/docs/admin/excluding-server-code#aliasing-server-only-modules).
-
-Even though there is a new property for Vite configs specifically, we have implemented some "compatibility" between Webpack and Vite out-of-the-box.
-
-If your config specifies Webpack aliases, we attempt to leverage them automatically within the Vite config. They are merged into the Vite alias configuration seamlessly and may work out-of-the-box.

docs/admin/webpack.mdx

@@ -1,67 +0,0 @@
----
-title: Webpack
-label: Webpack
-order: 80
-desc: The Payload admin panel uses Webpack 5 and supports many common functionalities such as SCSS and Typescript out of the box to give you more freedom.
-keywords: admin, webpack, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload has a Webpack (v5) bundler that you can build the Admin panel with. For now, we recommended using it because it is stable. If you are feeling a bit more adventurous you can give the [Vite](/docs/admin/vite) bundler a shot.
-
-Out of the box, the Webpack bundler supports common functionalities such as SCSS and Typescript, but there are many cases where you may need to add support for additional functionalities.
-
-#### Installation
-
-```bash
-yarn add @payloadcms/bundler-webpack
-```
-
-#### Import the bundler
-
-```ts
-// payload.config.ts
-
-import { buildConfig } from 'payload/config'
-import { webpackBundler } from '@payloadcms/bundler-webpack'
-
-export default buildConfig({
-  // highlight-start
-  admin: {
-    bundler: webpackBundler()
-  },
-  // highlight-end
-})
-```
-
-### Extending Webpack
-
-If you need to extend the Webpack config, you can do so by passing a function to the `admin.webpack` property on your Payload config.
-The function will receive the Webpack config as an argument and should return the modified config.
-
-```ts
-// payload.config.ts
-
-import { buildConfig } from 'payload/config'
-import { webpackBundler } from '@payloadcms/bundler-webpack'
-
-export default buildConfig({
-  admin: {
-    bundler: webpackBundler()
-    // highlight-start
-    webpack: (config) => {
-      // full control of the Webpack config
-
-      return config
-    },
-    // highlight-end
-  },
-})
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  If changes to your Webpack aliases are not surfacing, they might be
-  [cached](https://webpack.js.org/configuration/cache/) in `node_modules/.cache/webpack`. Try
-  deleting that folder and restarting your server.
-</Banner>

docs/authentication/config.mdx

@@ -1,292 +0,0 @@
----
-title: Authentication Config
-label: Config
-order: 20
-desc: Enable and customize options in the Authentication config for features including Forgot Password, Login Attempts, API key usage and more.
-keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload's Authentication is extremely powerful and gives you everything you need when you go to build a new app or site in a secure and responsible manner.
-
-To enable Authentication on a collection, define an `auth` property and set it to either `true` or to an object containing the options below.
-
-## Options
-
-| Option                     | Description                                                                                                                                                                                                                         |
-| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`useAPIKey`**            | Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection. [More](/docs/authentication/config#api-keys)                                                                       |
-| **`tokenExpiration`**      | How long (in seconds) to keep the user logged in. JWTs and HTTP-only cookies will both expire at the same time.                                                                                                                     |
-| **`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.                                                                       |
-| **`lockTime`**             | Set the time (in milliseconds) that a user should be locked out if they fail authentication more times than `maxLoginAttempts` allows for.                                                                                          |
-| **`depth`**                | How many levels deep a `user` document should be populated when creating the JWT and binding the `user` to the express `req`. Defaults to `0` and should only be modified if absolutely necessary, as this will affect performance. |
-| **`cookies`**              | Set cookie options, including `secure`, `sameSite`, and `domain`. For advanced users.                                                                                                                                               |
-| **`forgotPassword`**       | Customize the way that the `forgotPassword` operation functions. [More](/docs/authentication/config#forgot-password)                                                                                                                |
-| **`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](/docs/authentication/config#email-verification)                                  |
-| **`disableLocalStrategy`** | Advanced - disable Payload's built-in local auth strategy. Only use this property if you have replaced Payload's auth mechanisms with your own.                                                                                     |
-| **`strategies`**           | Advanced - an array of PassportJS authentication strategies to extend this collection's authentication with. [More](/docs/authentication/config#strategies)                                                                         |
-
-### API keys
-
-To integrate with third-party APIs or services, you might need the ability to generate API keys that can be used to identify as a certain user within Payload.
-
-In Payload, users are essentially documents within a collection. Just like you can authenticate as a user with an email and password, which is considered as our default local auth strategy, you can also authenticate as a user with an API key. API keys are generated on a user-by-user basis, similar to email and passwords, and are meant to represent a single user.
-
-For example, if you have a third-party service or external app that needs to be able to perform protected actions at its discretion, you have two options:
-
-1. Create a user for the third-party app, and log in each time to receive a token before you attempt to access any protected actions
-1. Enable API key support for the Collection, where you can generate a non-expiring API key per user in the collection. This is particularly useful as you can create a "user" that reflects an integration with a specific external service and assign a "role" or specific access only needed by that service/integration. Alternatively, you could create a "super admin" user and assign an API key to that user so that any requests made with that API key are considered as being made by that super user.
-
-Technically, both of these options will work for third-party integrations but the second option with API key is simpler, because it reduces the amount of work that your integrations need to do to be authenticated properly.
-
-To enable API keys on a collection, set the `useAPIKey` auth option to `true`. From there, a new interface will appear in the Admin panel for each document within the collection that allows you to generate an API key for each user in the Collection.
-
-<Banner type="success">
-  User API keys are encrypted within the database, meaning that if your database is compromised,
-  your API keys will not be.
-</Banner>
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  If you change your `PAYLOAD_SECRET`, you will need to regenerate your API keys.
-  <br />
-  The secret key is used to encrypt the API keys, so if you change the secret, existing API keys will no longer be valid.
-</Banner>
-
-#### Authenticating via API Key
-
-To authenticate REST or GraphQL API requests using an API key, set the `Authorization` header. The header is case-sensitive and needs the slug of the `auth.useAPIKey` enabled collection, then " API-Key ", followed by the `apiKey` that has been assigned. Payload's built-in middleware will then assign the user document to `req.user` and handle requests with the proper access control. By doing this, Payload recognizes the request being made as a request by the user associated with that API key.
-
-**For example, using Fetch:**
-
-```ts
-import User from '../collections/User'
-
-const response = await fetch('http://localhost:3000/api/pages', {
-  headers: {
-    Authorization: `${User.slug} API-Key ${YOUR_API_KEY}`,
-  },
-})
-```
-
-Payload ensures that the same, uniform access control is used across all authentication strategies. This enables you to utilize your existing access control configurations with both API keys and the standard email/password authentication. This consistency can aid in maintaining granular control over your API keys.
-
-#### API Key _Only_ Authentication
-
-If you want to use API keys as the only authentication method for a collection, you can disable the default local strategy by setting `disableLocalStrategy` to `true` on the collection's `auth` property. This will disable the ability to authenticate with email and password, and will only allow for authentication via API key.
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Customers: CollectionConfig = {
-  slug: 'customers',
-  auth: {
-    useAPIKey: true,
-    disableLocalStrategy: true,
-  },
-}
-```
-
-### Forgot Password
-
-You can customize how the Forgot Password workflow operates with the following options on the `auth.forgotPassword` property:
-
-**`generateEmailHTML`**
-
-Function that accepts one argument, containing `{ req, token, user }`, that allows for overriding the HTML within emails that are sent to users attempting to reset their password. The function should return a string that supports HTML, which can be a full HTML email.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  HTML templating can be used to create custom email templates, inline CSS automatically, and more.
-  You can make a reusable function that standardizes all email sent from Payload, which makes
-  sending custom emails more DRY. Payload doesn't ship with an HTML templating engine, so you are
-  free to choose your own.
-</Banner>
-
-Example:
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Customers: CollectionConfig = {
-  slug: 'customers',
-  auth: {
-    forgotPassword: {
-      // highlight-start
-      generateEmailHTML: ({ req, token, user }) => {
-        // Use the token provided to allow your user to reset their password
-        const resetPasswordURL = `https://yourfrontend.com/reset-password?token=${token}`
-
-        return `
-          <!doctype html>
-          <html>
-            <body>
-              <h1>Here is my custom email template!</h1>
-              <p>Hello, ${user.email}!</p>
-              <p>Click below to reset your password.</p>
-              <p>
-                <a href="${resetPasswordURL}">${resetPasswordURL}</a>
-              </p>
-            </body>
-          </html>
-        `
-      },
-      // highlight-end
-    },
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  If you specify a different URL to send your users to for resetting their password, such as a page
-  on the frontend of your app or similar, you need to handle making the call to the Payload REST or
-  GraphQL reset-password operation yourself on your frontend, using the token that was provided for
-  you. Above, it was passed via query parameter.
-</Banner>
-
-**`generateEmailSubject`**
-
-Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
-
-Example:
-
-```ts
-{
-  slug: 'customers',
-  auth: {
-    forgotPassword: {
-      // highlight-start
-      generateEmailSubject: ({ req, user }) => {
-        return `Hey ${user.email}, reset your password!`;
-      }
-      // highlight-end
-    }
-  }
-}
-```
-
-### Email Verification
-
-If you'd like to require email verification before a user can successfully log in, you can enable it by passing `true` or an `options` object to `auth.verify`. The following options are available:
-
-**`generateEmailHTML`**
-
-Function that accepts one argument, containing `{ req, token, user }`, that allows for overriding the HTML within emails that are sent to users indicating how to validate their account. The function should return a string that supports HTML, which can optionally be a full HTML email.
-
-Example:
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Customers: CollectionConfig = {
-  slug: 'customers',
-  auth: {
-    verify: {
-      // highlight-start
-      generateEmailHTML: ({ req, token, user }) => {
-        // Use the token provided to allow your user to verify their account
-        const url = `https://yourfrontend.com/verify?token=${token}`
-
-        return `Hey ${user.email}, verify your email by clicking here: ${url}`
-      },
-      // highlight-end
-    },
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  If you specify a different URL to send your users to for email verification, such as a page on the
-  frontend of your app or similar, you need to handle making the call to the Payload REST or GraphQL
-  verification operation yourself on your frontend, using the token that was provided for you.
-  Above, it was passed via query parameter.
-</Banner>
-
-**`generateEmailSubject`**
-
-Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
-
-Example:
-
-```ts
-{
-  slug: 'customers',
-  auth: {
-    verify: {
-      // highlight-start
-      generateEmailSubject: ({ req, user }) => {
-        return `Hey ${user.email}, reset your password!`;
-      }
-      // highlight-end
-    }
-  }
-}
-```
-
-### Strategies
-
-As of Payload `1.0.0`, you can add additional authentication strategies to Payload easily by passing them to your collection's `auth.strategies` array.
-
-Behind the scenes, Payload uses PassportJS to power its local authentication strategy, so most strategies listed on the PassportJS website will work seamlessly. Combined with adding custom components to the admin panel's `Login` view, you can create advanced authentication strategies directly within Payload.
-
-<Banner type="warning">
-  This is an advanced feature, so only attempt this if you are an experienced developer. Otherwise,
-  just let Payload's built-in authentication handle user auth for you.
-</Banner>
-
-The `strategies` property is an array that takes objects with the following properties:
-
-**`strategy`**
-
-This property can accept a Passport strategy directly, or you can pass a function that takes a `payload` argument, and returns a Passport strategy.
-
-**`name`**
-
-If you pass a strategy to the `strategy` property directly, the `name` property is optional and allows you to override the strategy's built-in name.
-
-However, if you pass a function to `strategy`, `name` is a required property.
-
-In either case, Payload will prefix the strategy name with the collection `slug` that the strategy is passed to.
-
-### Admin autologin
-
-For testing and demo purposes you may want to skip forcing the admin user to login in order to access the panel.
-The `admin.autologin` property is used to configure the how visitors are handled when accessing the admin panel.
-The default is that all users will have to login and this should not be enabled for environments where data needs to protected.
-
-#### autoLogin Options
-
-| Option            | Description                                                                                                     |
-| ----------------- | --------------------------------------------------------------------------------------------------------------- |
-| **`email`**       | The email address of the user to login as                                                                       |
-| **`password`**    | The password of the user to login as                                                                            |
-| **`prefillOnly`** | If set to true, the login credentials will be prefilled but the user will still need to click the login button. |
-
-The recommended way to use this feature is behind an environment variable to ensure it is disabled when in production.
-
-**Example:**
-
-```ts
-export default buildConfig({
-  admin: {
-    user: 'users',
-    // highlight-start
-    autoLogin:
-      process.env.PAYLOAD_PUBLIC_ENABLE_AUTOLOGIN === 'true'
-        ? {
-            email: 'test@example.com',
-            password: 'test',
-            prefillOnly: true,
-          }
-        : false,
-    // highlight-end
-  },
-  collections: [
-    /** */
-  ],
-})
-```

docs/authentication/operations.mdx

@@ -1,405 +0,0 @@
----
-title: Authentication Operations
-label: Operations
-order: 30
-desc: Enabling Authentication automatically makes key operations available such as Login, Logout, Verify, Unlock, Reset Password and more.
-keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Enabling Authentication on a Collection automatically exposes additional auth-based operations in the Local, REST, and GraphQL APIs.
-
-### Access
-
-The Access operation returns what a logged in user can and can't do with the collections and globals that are registered via your config. This data can be immensely helpful if your app needs to show and hide certain features based on access control, as the Payload Admin panel does.
-
-**REST API endpoint**:
-
-`GET http://localhost:3000/api/access`
-
-Example response:
-
-```ts
-{
-  canAccessAdmin: true,
-  collections: {
-    pages: {
-      create: {
-        permission: true,
-      },
-      read: {
-        permission: true,
-      },
-      update: {
-        permission: true,
-      },
-      delete: {
-        permission: true,
-      },
-      fields: {
-        title: {
-          create: {
-            permission: true,
-          },
-          read: {
-            permission: true,
-          },
-          update: {
-            permission: true,
-          },
-        }
-      }
-    }
-  }
-}
-```
-
-**Example GraphQL Query**:
-
-```graphql
-query {
-  Access {
-    pages {
-      read {
-        permission
-      }
-    }
-  }
-}
-```
-
-Document access can also be queried on a collection/global basis. Access on a global can queried like `http://localhost:3000/api/global-slug/access`, Collection document access can be queried like `http://localhost:3000/api/collection-slug/access/:id`.
-
-### Me
-
-Returns either a logged in user with token or null when there is no logged in user.
-
-**REST API endpoint**:
-
-`GET http://localhost:3000/api/[collection-slug]/me`
-
-Example response:
-
-```ts
-{
-  user: { // The JWT "payload" ;) from the logged in user
-    email: 'dev@payloadcms.com',
-    createdAt: "2020-12-27T21:16:45.645Z",
-    updatedAt: "2021-01-02T18:37:41.588Z",
-    id: "5ae8f9bde69e394e717c8832"
-  },
-  token: '34o4345324...', // The token that can be used to authenticate the user
-  exp: 1609619861, // Unix timestamp representing when the user's token will expire
-}
-```
-
-**Example GraphQL Query**:
-
-```graphql
-query {
-  me[collection-singular-label] {
-    user {
-      email
-    }
-    exp
-  }
-}
-```
-
-### Login
-
-Accepts an `email` and `password`. On success, it will return the logged in user as well as a token that can be used to authenticate. In the GraphQL and REST APIs, this operation also automatically sets an HTTP-only cookie including the user's token. If you pass an Express `res` to the Local API operation, Payload will set a cookie there as well.
-
-**Example REST API login**:
-
-```ts
-const res = await fetch('http://localhost:3000/api/[collection-slug]/login', {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json',
-  },
-  body: JSON.stringify({
-    email: 'dev@payloadcms.com',
-    password: 'this-is-not-our-password...or-is-it?',
-  }),
-})
-
-const json = await res.json()
-
-// JSON will be equal to the following:
-/*
-{
-  user: {
-    email: 'dev@payloadcms.com',
-    createdAt: "2020-12-27T21:16:45.645Z",
-    updatedAt: "2021-01-02T18:37:41.588Z",
-    id: "5ae8f9bde69e394e717c8832"
-  },
-  token: '34o4345324...',
-  exp: 1609619861
-}
-*/
-```
-
-**Example GraphQL Mutation**:
-
-```graphql
-mutation {
-  login[collection-singular-label](email: "dev@payloadcms.com", password: "yikes") {
-    user {
-      email
-    }
-    exp
-    token
-  }
-}
-```
-
-**Example Local API login**:
-
-```ts
-const result = await payload.login({
-  collection: '[collection-slug]',
-  data: {
-    email: 'dev@payloadcms.com',
-    password: 'get-out',
-  },
-})
-```
-
-### Logout
-
-As Payload sets HTTP-only cookies, logging out cannot be done by just removing a cookie in JavaScript, as HTTP-only cookies are inaccessible by JS within the browser. So, Payload exposes a `logout` operation to delete the token in a safe way.
-
-**Example REST API logout**:
-
-```ts
-const res = await fetch('http://localhost:3000/api/[collection-slug]/logout', {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json',
-  },
-})
-```
-
-**Example GraphQL Mutation**:
-
-```
-mutation {
-  logout[collection-singular-label]
-}
-```
-
-### Refresh
-
-Allows for "refreshing" JWTs. If your user has a token that is about to expire, but the user is still active and using the app, you might want to use the `refresh` operation to receive a new token by sending the operation the token that is about to expire.
-
-This operation requires a non-expired token to send back a new one. If the user's token has already expired, you will need to allow them to log in again to retrieve a new token.
-
-If successful, this operation will automatically renew the user's HTTP-only cookie and will send back the updated token in JSON.
-
-**Example REST API token refresh**:
-
-```ts
-const res = await fetch('http://localhost:3000/api/[collection-slug]/refresh-token', {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json',
-  },
-})
-
-const json = await res.json()
-
-// JSON will be equal to the following:
-/*
-{
-  user: {
-    email: 'dev@payloadcms.com',
-    createdAt: "2020-12-27T21:16:45.645Z",
-    updatedAt: "2021-01-02T18:37:41.588Z",
-    id: "5ae8f9bde69e394e717c8832"
-  },
-  refreshedToken: '34o4345324...',
-  exp: 1609619861
-}
-*/
-```
-
-**Example GraphQL Mutation**:
-
-```
-mutation {
-  refreshToken[collection-singular-label] {
-    user {
-      email
-    }
-    refreshedToken
-  }
-}
-```
-
-<Banner type="success">
-  The Refresh operation will automatically find the user's token in either a JWT header or the
-  HTTP-only cookie. But, you can specify the token you're looking to refresh by providing the REST
-  API with a `token` within the JSON body of the request, or by providing the GraphQL resolver a
-  `token` arg.
-</Banner>
-
-### Verify by Email
-
-If your collection supports email verification, the Verify operation will be exposed which accepts a verification token and sets the user's `_verified` property to `true`, thereby allowing the user to authenticate with the Payload API.
-
-**Example REST API user verification**:
-
-```ts
-const res = await fetch(`http://localhost:3000/api/[collection-slug]/verify/${TOKEN_HERE}`, {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json',
-  },
-})
-```
-
-**Example GraphQL Mutation**:
-
-```graphql
-mutation {
-  verifyEmail[collection-singular-label](token: "TOKEN_HERE")
-}
-```
-
-**Example Local API verification**:
-
-```ts
-const result = await payload.verifyEmail({
-  collection: '[collection-slug]',
-  token: 'TOKEN_HERE',
-})
-```
-
-### Unlock
-
-If a user locks themselves out and you wish to deliberately unlock them, you can utilize the Unlock operation. The Admin panel features an Unlock control automatically for all collections that feature max login attempts, but you can programmatically unlock users as well by using the Unlock operation.
-
-To restrict who is allowed to unlock users, you can utilize the [`unlock`](/docs/access-control/overview#unlock) access control function.
-
-**Example REST API unlock**:
-
-```ts
-const res = await fetch(`http://localhost:3000/api/[collection-slug]/unlock`, {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json',
-  },
-})
-```
-
-**Example GraphQL Mutation**:
-
-```
-mutation {
-  unlock[collection-singular-label]
-}
-```
-
-**Example Local API unlock**:
-
-```ts
-const result = await payload.unlock({
-  collection: '[collection-slug]',
-})
-```
-
-### Forgot Password
-
-Payload comes with built-in forgot password functionality. Submitting an email address to the Forgot Password operation will generate an email and send it to the respective email address with a link to reset their password.
-
-The link to reset the user's password contains a token which is what allows the user to securely reset their password.
-
-By default, the Forgot Password operations send users to the Payload Admin panel to reset their password, but you can customize the generated email to send users to the frontend of your app instead by [overriding the email HTML](/docs/authentication/config#forgot-password).
-
-**Example REST API Forgot Password**:
-
-```ts
-const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-password`, {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json',
-  },
-  body: JSON.stringify({
-    email: 'dev@payloadcms.com',
-  }),
-})
-```
-
-**Example GraphQL Mutation**:
-
-```
-mutation {
-  forgotPassword[collection-singular-label](email: "dev@payloadcms.com")
-}
-```
-
-**Example Local API forgot password**:
-
-```ts
-const token = await payload.forgotPassword({
-  collection: '[collection-slug]',
-  data: {
-    email: 'dev@payloadcms.com',
-  },
-  disableEmail: false, // you can disable the auto-generation of email via local API
-})
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  You can stop the reset-password email from being sent via using the local API. This is helpful if
-  you need to create user accounts programmatically, but not set their password for them. This
-  effectively generates a reset password token which you can then use to send to a page you create,
-  allowing a user to "complete" their account by setting their password. In the background, you'd
-  use the token to "reset" their password.
-</Banner>
-
-### Reset Password
-
-After a user has "forgotten" their password and a token is generated, that token can be used to send to the reset password operation along with a new password which will allow the user to reset their password securely.
-
-**Example REST API Reset Password**:
-
-```ts
-const res = await fetch(`http://localhost:3000/api/[collection-slug]/reset-password`, {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json',
-  },
-  body: JSON.stringify({
-    token: 'TOKEN_GOES_HERE'
-    password: 'not-today',
-  }),
-});
-
-const json = await res.json();
-
-// JSON will be equal to the following:
-/*
-{
-  user: {
-    email: 'dev@payloadcms.com',
-    createdAt: "2020-12-27T21:16:45.645Z",
-    updatedAt: "2021-01-02T18:37:41.588Z",
-    id: "5ae8f9bde69e394e717c8832"
-  },
-  token: '34o4345324...',
-  exp: 1609619861
-}
-*/
-```
-
-**Example GraphQL Mutation**:
-
-```graphql
-mutation {
-  resetPassword[collection-singular-label](token: "TOKEN_GOES_HERE", password: "not-today")
-}
-```

docs/authentication/overview.mdx

@@ -1,181 +0,0 @@
----
-title: Authentication Overview
-label: Overview
-order: 10
-desc: Payload provides highly secure user Authentication out of the box, and you can fully customize, override, or remove the default Authentication support.
-keywords: authentication, config, configuration, overview, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<YouTube
-  id="CT4KafeJjTI"
-  title="Simplified Authentication for Headless CMS: Unlocking Reusability in One Line"
-/>
-
-<Banner>
-  Payload provides for highly secure and customizable user Authentication out of the box, which
-  allows for users to identify themselves to Payload.
-</Banner>
-
-Authentication is used within the Payload Admin panel itself as well as throughout your app(s) themselves however you determine necessary.
-
-![Authentication admin panel functionality](https://payloadcms.com/images/docs/auth-admin.jpg)
-_Admin panel screenshot depicting an Admins Collection with Auth enabled_
-
-**Here are some common use cases of Authentication outside of Payload's dashboard itself:**
-
-- Customer accounts for an ecommerce app
-- Customer accounts for a SaaS product
-- P2P app or social site where users need to log in and manage their profiles
-- Online game where players need to track their progress over time
-
-By default, Payload provides you with a `User` collection that supports Authentication, which is used to access the Admin panel. But, you can add support to one or many Collections of your own. For more information on how to customize, override, or remove the default `User` collection, [click here](/docs/admin/overview#the-admin-user-collection).
-
-### Enabling Auth on a collection
-
-Every Payload Collection can opt-in to supporting Authentication by specifying the `auth` property on the Collection's config to either `true` or to an object containing `auth` options.
-
-**For a full list of all `auth` options, [click here](/docs/authentication/config).**
-
-Simple example collection:
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Admins: CollectionConfig = {
-  slug: 'admins',
-  // highlight-start
-  auth: {
-    tokenExpiration: 7200, // How many seconds to keep the user logged in
-    verify: true, // Require email verification before being allowed to authenticate
-    maxLoginAttempts: 5, // Automatically lock a user out after X amount of failed logins
-    lockTime: 600 * 1000, // Time period to allow the max login attempts
-    // More options are available
-  },
-  // highlight-end
-  fields: [
-    {
-      name: 'role',
-      type: 'select',
-      required: true,
-      options: [
-        'user',
-        'admin',
-        'editor',
-        'developer',
-      ],
-    },
-  ],
-}
-```
-
-**By enabling Authentication on a config, the following modifications will automatically be made to your Collection:**
-
-1. `email` as well as password `salt` & `hash` fields will be added to your Collection's schema
-1. The Admin panel will feature a new set of corresponding UI to allow for changing password and editing email
-1. [A new set of `operations`](/docs/authentication/operations) will be exposed via Payload's REST, Local, and GraphQL APIs
-
-Once enabled, each document that is created within the Collection can be thought of as a `user` - who can make use of commonly required authentication functions such as logging in / out, resetting their password, and more.
-
-### Logging in / out, resetting password, etc.
-
-[Click here](/docs/authentication/operations) for a list of all automatically-enabled Auth operations, including `login`, `logout`, `refresh`, and others.
-
-### Token-based auth
-
-Successfully logging in returns a `JWT` (JSON web token) which is how a user will identify themselves to Payload. By providing this JWT via either an HTTP-only cookie or an `Authorization: JWT` or `Authorization: Bearer` header, Payload will automatically identify the user and add its user JWT data to the Express `req`, which is available throughout Payload including within access control, hooks, and more.
-
-You can specify what data gets encoded to the JWT token by setting `saveToJWT` to true in your auth collection fields. If you wish to use a different key other than the field `name`, you can provide it to `saveToJWT` as a string. It is also possible to use `saveToJWT` on fields that are nested in inside groups and tabs. If a group has a `saveToJWT` set it will include the object with all sub-fields in the token. You can set `saveToJWT: false` for any fields you wish to omit. If a field inside a group has `saveToJWT` set, but the group does not, the field will be included at the top level of the token.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  You can access the logged-in user from access control functions and hooks via the Express{' '}
-  <strong>req</strong>. The logged-in user is automatically added as the <strong>user</strong>{' '}
-  property.
-</Banner>
-
-### HTTP-only cookies
-
-Payload `login`, `logout`, and `refresh` operations make use of HTTP-only cookies for authentication purposes. HTTP-only cookies are a highly secure method of storing identifiable data on a user's device so that Payload can automatically recognize a returning user until their cookie expires. They are totally protected from common XSS attacks and cannot be read at all via JavaScript in the browser.
-
-##### Automatic browser inclusion
-
-Modern browsers automatically include `http-only` cookies when making requests directly to URLs—meaning that if you are running your API on http://example.com, and you have logged in and visit http://example.com/test-page, your browser will automatically include the Payload authentication cookie for you.
-
-##### Using Fetch or other HTTP APIs
-
-However, if you use `fetch` or similar APIs to retrieve Payload resources from its REST or GraphQL API, you need to specify to include credentials (cookies).
-
-Fetch example, including credentials:
-
-```ts
-const response = await fetch('http://localhost:3000/api/pages', {
-  credentials: 'include',
-})
-
-const pages = await response.json()
-```
-
-For more about how to automatically include cookies in requests from your app to your Payload API, [click here](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Sending_a_request_with_credentials_included).
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  To make sure you have a Payload cookie set properly in your browser after logging in, you can use
-  Chrome's Developer Tools - Application - Cookies - [your-domain-here]. The Chrome Developer tools
-  will still show HTTP-only cookies, even when JavaScript running on the page can't.
-</Banner>
-
-### CSRF Protection
-
-CSRF (cross-site request forgery) attacks are common and dangerous. By using an HTTP-only cookie, Payload removes many XSS vulnerabilities, however, CSRF attacks can still be possible.
-
-For example, let's say you have a very popular app running at coolsite.com. This app allows users to manage finances and send / receive money. As Payload is using HTTP-only cookies, that means that browsers automatically will include cookies when sending requests to your domain - no matter what page created the request.
-
-So, if a user of coolsite.com is logged in and just browsing around on the internet, they might stumble onto a page with bad intentions. That bad page might automatically make requests to all sorts of sites to see if they can find one that they can log into - and coolsite.com might be on their list. If your user was logged in while they visited that evil site, the attacker could do whatever they wanted as if they were your coolsite.com user by just sending requests to the coolsite API (which would automatically include the auth cookie). They could send themselves a bunch of money from your user's account, change the user's password, etc. This is what a CSRF attack is.
-
-<Banner type="warning">
-  <strong>
-    To protect against CSRF attacks, Payload only accepts cookie-based authentication from domains
-    that you explicitly whitelist.
-  </strong>
-</Banner>
-
-To define domains that should allow users to identify themselves via the Payload HTTP-only cookie, use the `csrf` option on the base Payload config to whitelist domains that you trust.
-
-`payload.config.ts`:
-
-```ts
-import { buildConfig } from 'payload/config'
-
-const config = buildConfig({
-  collections: [
-    // collections here
-  ],
-  // highlight-start
-  csrf: [
-    // whitelist of domains to allow cookie auth from
-    'https://your-frontend-app.com',
-    'https://your-other-frontend-app.com',
-  ],
-  // highlight-end
-})
-
-export default config
-```
-
-### Identifying users via the Authorization Header
-
-In addition to authenticating via an HTTP-only cookie, you can also identify users via the `Authorization` header on an HTTP request.
-
-Example:
-
-```ts
-const request = await fetch('http://localhost:3000', {
-  headers: {
-    Authorization: `JWT ${token}`,
-  },
-})
-```
-
-You can retrieve a user's token via the response to `login`, `refresh`, and `me` auth operations.

docs/authentication/using-middleware.mdx

@@ -1,56 +0,0 @@
----
-title: Using the Payload Auth Middleware
-label: Using the Middleware
-order: 40
-desc: Make full use of Payload's built-in authentication with your own custom Express endpoints by adding Payload's authentication middleware.
-keywords: authentication, middleware, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Because Payload uses your existing Express server, you are free to add whatever logic you need to your app through endpoints of your own. However, Payload does not add its middleware to your Express app itself—instead, it scopes all of its middleware to Payload-specific routers.
-
-This approach has a ton of benefits - it's great for isolation of concerns and limiting scope, but it also means that your additional routes won't have access to Payload's user authentication.
-
-<Banner type="success">
-  You can make full use of Payload's built-in authentication within your own custom Express
-  endpoints by adding Payload's authentication middleware.
-</Banner>
-
-<Banner type="warning">
-  Payload must be initialized before the `payload.authenticate` middleware can be used. This is done
-  by calling `payload.init()` prior to adding the middleware.
-</Banner>
-
-Example in `server.js`:
-
-```ts
-import express from 'express'
-import payload from 'payload'
-
-const app = express()
-
-const start = async () => {
-  await payload.init({
-    secret: 'PAYLOAD_SECRET_KEY',
-    express: app,
-  })
-
-  const router = express.Router()
-
-  // Note: Payload must be initialized before the `payload.authenticate` middleware can be used
-  router.use(payload.authenticate) // highlight-line
-
-  router.get('/', (req, res) => {
-    if (req.user) {
-      return res.send(`Authenticated successfully as ${req.user.email}.`)
-    }
-
-    return res.send('Not authenticated')
-  })
-
-  app.use('/some-route-here', router)
-
-  app.listen(3000)
-}
-
-start()
-```

docs/cloud/configuration.mdx

@@ -1,61 +0,0 @@
----
-title: Project Configuration
-label: Configuration
-order: 20
-desc: Quickly configure and deploy your Payload Cloud project in a few simple steps.
-keywords: configuration, config, settings, project, cloud, payload cloud, deploy, deployment
----
-
-### Select your plan
-
-Once you have created a project, you will need to select your plan. This will determine the resources that are allocated to your project and the features that are available to you.
-
-<Banner type="success">
-  Note: All Payload Cloud teams that deploy a project require a card on file. This helps us prevent
-  fraud and abuse on our platform. If you select a plan with a free trial, you will not be charged
-  until your trial period is over. We’ll remind you 7 days before your trial ends and you can cancel
-  anytime.
-</Banner>
-
-### Project Details
-
-| Option           | Description                                                                                                                                                                                                                                   |
-| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **Region**       | Select the region closest to your audience. This will ensure the fastest communication between your data and your client.                                                                                                                     |
-| **Project Name** | A name for your project. You can change this at any time.                                                                                                                                                                                     |
-| **Project Slug** | Choose a unique slug to identify your project. This needs to be unique for your team and you can change it any time.                                                                                                                          |
-| **Team**         | Select the team you want to create the project under. If this is your first project, a personal team will be created for you automatically. You can modify your team settings and invite new members at any time from the Team Settings page. |
-
-### Build Settings
-
-If you are deploying a new project from a template, the following settings will be automatically configured for you. If you are using your own repository, you need to make sure your build settings are accurate for your project to deploy correctly.
-
-| Option               | Description                                                                                                                                                       |
-| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **Root Directory**   | The folder where your `package.json` file lives.                                                                                                                  |
-| **Install Command**  | The command used to install your modules, for example: `yarn install` or `npm install`                                                                            |
-| **Build Command**    | The command used to build your application, for example: `yarn build` or `npm run build`                                                                          |
-| **Serve Command**    | The command used to serve your application, for example: `yarn serve` or `npm run serve`                                                                          |
-| **Branch to Deploy** | Select the branch of your repository that you want to deploy from. This is the branch that will be used to build your project when you commit new changes.        |
-| **Default Domain**   | Set a default domain for your project. This must be unique and you will not able to change it. You can always add a custom domain later in your project settings. |
-
-### Environment Variables
-
-Any of the features in Payload Cloud that require environment variables will automatically be provided to your application. If your app requires any custom environment variables, you can set them here.
-
-<Banner type="warning">
-  Note: For security reasons, any variables you wish to provide to the Admin panel must be prefixed
-  with `PAYLOAD_PUBLIC_`.  Learn more
-  [here](https://payloadcms.com/docs/admin/webpack#admin-environment-vars).
-</Banner>
-
-### Payment
-
-Payment methods can be set per project and can be updated any time. You can use team’s default payment method, or add a new one. Modify your payment methods in your Project settings / Team settings.
-
-<Banner type="success">
-  <strong>Note:</strong> All Payload Cloud teams that deploy a project require a card on file. This
-  helps us prevent fraud and abuse on our platform. If you select a plan with a free trial, you will
-  not be charged until your trial period is over. We’ll remind you 7 days before your trial ends and
-  you can cancel anytime.
-</Banner>

docs/cloud/creating-a-project.mdx

@@ -1,51 +0,0 @@
----
-title: Getting Started
-label: Getting Started
-order: 10
-desc: Get started with Payload Cloud, a deployment solution specifically designed for Node + MongoDB applications.
-keywords: cloud, hosted, database, storage, email, deployment, serverless, node, mongodb, s3, aws, cloudflare, atlas, resend, payload, cms
----
-
-A deployment solution specifically designed for Node.js + MongoDB applications, offering seamless deployment of your entire stack in one place. You can get started in minutes with a one-click template or bring your own codebase with you.
-
-Payload Cloud offers various plans tailored to meet your specific needs, including a MongoDB Atlas database, S3 file storage, and email delivery powered by [Resend](https://resend.com). To see a full breakdown of features and plans, see our [Cloud Pricing page](https://payloadcms.com/cloud-pricing).
-
-To get started, you first need to create an account. Head over to [the login screen](https://payloadcms.com/login) and **Register for Free**.
-
-<Banner type="success">
-  To create your first project, you can either select [a template](#starting-from-a-template) or
-  [import an existing project](#importing-from-an-existing-codebase) from GitHub.
-</Banner>
-
-## Starting from a Template
-
-Templates come preconfigured and provide a one-click solution to quickly deploy a new application.
-
-![Screen for creating a new project from a template](https://payloadcms.com/images/docs/cloud/create-from-template.jpg)
-_Creating a new project from a template._
-
-After creating an account, select your desired template from the Projects page. At this point, you need to connect to authorize the Payload Cloud application with your GitHub account. Click Continue with GitHub and follow the prompts to authorize the app.
-
-Next, select your `GitHub Scope`. If you belong to multiple organizations, they will show up here. If you do not see the organization you are looking for, you may need to adjust your GitHub app permissions.
-
-After selecting your scope, create a unique `repository name` and select whether you want your repository to be public or private on GitHub.
-
-<Banner type="warning">
-  <strong>Note:</strong> Public repositories can be accessed by anyone online, while private
-  repositories grant access only to you and anyone you explicitly authorize.
-</Banner>
-
-Once you are ready, click **Create Project**. This will clone the selected template to a new repository in your GitHub account, and take you to the configuration page to set up your project for deployment.
-
-## Importing from an Existing Codebase
-
-Payload Cloud works for any Node.js + MongoDB app. From the New Project page, select **import an existing Git codebase**. Choose the organization and select the repository you want to import. From here, you will be taken to the configuration page to set up your project for deployment.
-
-![Screen for creating a new project from an existing repository](https://payloadcms.com/images/docs/cloud/create-from-existing.jpg)
-_Creating a new project from an existing repository._
-
-<Banner type="warning">
-  <strong>Note:</strong> In order to make use of the features of Payload Cloud in your own codebase,
-  you will need to add the [Cloud Plugin](https://github.com/payloadcms/plugin-cloud) to your
-  Payload app.
-</Banner>

docs/cloud/projects.mdx

@@ -1,129 +0,0 @@
----
-title: Cloud Projects
-label: Projects
-order: 40
-desc: Manage your Payload Cloud projects.
-keywords: cloud, payload cloud, projects, project, overview, database, file storage, build settings, environment variables, custom domains, email, developing locally
----
-
-### Overview
-
-<Banner>
-  The overview tab shows your most recent deployment, along with build and deployment logs. From
-  here, you can see your live URL, deployment details like timestamps and commit hash, as well as
-  the status of your deployment. You can also trigger a redeployment manually, which will rebuild
-  your project using the current configuration.
-</Banner>
-
-![Payload Cloud Overview Page](https://payloadcms.com/images/docs/cloud/overview-page.jpg)
-_A screenshot of the Overview page for a Cloud project._
-
-### Database
-
-Your Payload Cloud project comes with a MongoDB serverless Atlas DB instance or a Dedicated Atlas cluster, depending on your plan. To interact with your cloud database, you will be provided with a MongoDB connection string. This can be found under the **Database** tab of your project.
-
-`mongodb+srv://your_connection_string`
-
-### File Storage
-
-Payload Cloud gives you S3 file storage backed by Cloudflare as a CDN, and this plugin extends Payload so that all of your media will be stored in S3 rather than locally.
-
-AWS Cognito is used for authentication to your S3 bucket. The [Payload Cloud Plugin](https://github.com/payloadcms/plugin-cloud) will automatically pick up these values. These values are only if you'd like to access your files directly, outside of Payload Cloud.
-
-#### Accessing Files Outside of Payload Cloud
-
-If you'd like to access your files outside of Payload Cloud, you'll need to retrieve some values from your project's settings and put them into your environment variables. In Payload Cloud, navigate to the File Storage tab and copy the values using the copy button. Put these values in your .env file. Also copy the Cognito Password value separately and put into your .env file as well.
-
-When you are done, you should have the following values in your .env file:
-
-```env
-PAYLOAD_CLOUD=true
-PAYLOAD_CLOUD_ENVIRONMENT=prod
-PAYLOAD_CLOUD_COGNITO_USER_POOL_CLIENT_ID=
-PAYLOAD_CLOUD_COGNITO_USER_POOL_ID=
-PAYLOAD_CLOUD_COGNITO_IDENTITY_POOL_ID=
-PAYLOAD_CLOUD_PROJECT_ID=
-PAYLOAD_CLOUD_BUCKET=
-PAYLOAD_CLOUD_BUCKET_REGION=
-PAYLOAD_CLOUD_COGNITO_PASSWORD=
-```
-
-The plugin will pick up these values and use them to access your files.
-
-### Build Settings
-
-You can update settings from your Project’s Settings tab. Changes to your build settings will trigger a redeployment of your project.
-
-### Environment Variables
-
-From the Environment Variables page of the Settings tab, you can add, update and delete variables for use in your project. Like build settings, these changes will trigger a redeployment of your project.
-
-<Banner>
-  Note: For security reasons, any variables you wish to provide to the Admin panel must be prefixed
-  with `PAYLOAD_PUBLIC_`.  Learn more
-  [here](https://payloadcms.com/docs/admin/webpack#admin-environment-vars).
-</Banner>
-
-### Custom Domains
-
-With Payload Cloud, you can add custom domain names to your project. To do so, first go to the Domains page of the Settings tab of your project. Here you can see your default domain. To add a new domain, type in the domain name you wish to use.
-
-<Banner>
-  Note: do not include the protocol (http:// or https://) or any paths (/page). Only include the
-  domain name and extension, and optionally a subdomain. - your-domain.com - backend.your-domain.com
-</Banner>
-
-Once you click save, a DNS record will be generated for your domain name to point to your live project. Add this record into your DNS provider’s records, and once the records are resolving properly (this can take 1hr to 48hrs in some cases), your domain will now to point to your live project.
-
-You will also need to configure your Payload project to use your specified domain. In your `payload.config.ts` file, specify your `serverURL` with your domain:
-
-```ts
-export default buildConfig({
-  serverURL: 'https://example.com',
-  // the rest of your config,
-})
-```
-
-### Email
-
-Powered by [Resend](https://resend.com), Payload Cloud comes with integrated email support out of the box. No configuration is needed, and you can use `payload.sendEmail()` to send email right from your Payload app. To learn more about sending email with Payload, checkout the [Email Configuration](https://payloadcms.com/docs/email/overview) overview.
-
-If you are on the Pro or Enterprise plan, you can add your own custom Email domain name. From the Email page of your project’s Settings, add the domain you wish to use for email delivery. This will generate a set of DNS records. Add these records to your DNS provider and click verify to check that your records are resolving properly. Once verified, your emails will now be sent from your custom domain name.
-
-### Developing Locally
-
-To make changes to your project, you will need to clone the repository defined in your project settings to your local machine. In order to run your project locally, you will need configure your local environment first. Refer to your repository’s `README.md` file to see the steps needed for your specific template.
-
-From there, you are ready to make updates to your project. When you are ready to make your changes live, commit your changes to the branch you specified in your Project settings, and your application will automatically trigger a redeploy and build from your latest commit.
-
-### Cloud Plugin
-
-Projects generated from a template will come pre-configured with the official Cloud Plugin, but if you are using your own repository you will need to add this into your project. To do so, add the plugin to your Payload config:
-
-`yarn add @payloadcms/plugin-cloud`
-
-```js
-import { payloadCloud } from '@payloadcms/plugin-cloud'
-import { buildConfig } from 'payload/config'
-
-export default buildConfig({
-  plugins: [payloadCloud()],
-  // rest of config
-})
-```
-
-<Banner type="warning">
-  **Note:** If your Payload config already has an email with transport, this will take precedence
-  over Payload Cloud's email service.
-</Banner>
-
-##### **Optional configuration**
-
-If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.
-
-```js
-payloadCloud({
-  storage: false, // Disable file storage
-  email: false, // Disable email delivery
-})
-```

docs/cloud/teams.mdx

@@ -1,35 +0,0 @@
----
-title: Cloud Teams
-label: Teams
-order: 30
-desc: Manage your Payload Cloud team and billing settings.
-keywords: team, teams, billing, subscription, payment, plan, plans, cloud, payload cloud
----
-
-<Banner>
-  Within Payload Cloud, the team management feature offers you the ability to manage your
-  organization, team members, billing, and subscription settings.
-</Banner>
-
-![Payload Cloud Team Settings](https://payloadcms.com/images/docs/cloud/team-settings.jpg)
-_A screenshot of the Team Settings page._
-
-### Members
-
-Each team has members that can interact with your projects. You can invite multiple people to your team and each individual can belong to more than one team. You can assign them either `owner` or `user` permissions. Owners are able to make admin-only changes, such as deleting projects, and editing billing information.
-
-### Adding Members
-
-To add a new member to your team, visit your Team’s Settings page, and click “Invite Teammate”. You can then add their email address, and assign their role. Press “Save” to send the invitations, which will send an email to the invited team member where they can create a new account.
-
-### Billing
-
-Users can update billing settings and subscriptions for any teams where they are designated as an `owner`. To make updates to the team’s payment methods, visit the Billing page under the Team Settings tab. You can add new cards, delete cards, and set a payment method as a default. The default payment method will be used in the event that another payment method fails.
-
-### Subscriptions
-
-From the Subscriptions page, a team owner can see all current plans for their team. From here, you can see the price of each plan, if there is an active trial, and when you will be billed next.
-
-### Invoices
-
-The Invoices page will you show you the invoices for your account, as well as the status on their payment.

docs/configuration/collections.mdx

@@ -1,235 +0,0 @@
----
-title: Collection Configs
-label: Collections
-order: 20
-desc: Structure your Collections for your needs by defining fields, adding slugs and labels, establishing access control, tying in hooks, setting timestamps and more.
-keywords: collections, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload Collections are defined through configs of their own, and you can define as many as your application needs. Each
-Collection will scaffold a new collection automatically in your database of choice, based on fields that you define.
-
-It's often best practice to write your Collections in separate files and then import them into the main Payload config.
-
-## Options
-
-| Option            | Description                                                                                                                                                                                                              |
-|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`slug`** \*     | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                          |
-| **`fields`** \*   | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
-| **`labels`**      | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                           |
-| **`admin`**       | Admin-specific configuration. See below for [more detail](#admin-options).                                                                                                                                               |
-| **`hooks`**       | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/overview#collection-hooks)                                                                                                         |
-| **`access`**      | Provide access control functions to define exactly who should be able to do what with Documents in this Collection. [More](/docs/access-control/overview/#collections)                                                   |
-| **`auth`**        | Specify options if you would like this Collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation.                                                          |
-| **`upload`**      | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](/docs/upload/overview) documentation.                                                                         |
-| **`timestamps`**  | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                                                       |
-| **`versions`**    | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#collection-config)                                                                                            |
-| **`endpoints`**   | Add custom routes to the REST API. Set to `false` to disable routes. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                    |
-| **`graphQL`**     | An object with `singularName` and `pluralName` strings used in schema generation. Auto-generated from slug if not defined. Set to `false` to disable GraphQL.                                                            |
-| **`typescript`**  | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                      |
-| **`defaultSort`** | Pass a top-level field to sort by default in the collection List view. Prefix the name of the field with a minus symbol ("-") to sort in descending order.                                                               |
-| **`custom`**      | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                |
-| **`dbName`**      | Custom table or collection name depending on the database adapter. Auto-generated from slug if not defined.
-
-_\* An asterisk denotes that a property is required._
-
-#### Simple collection example
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Orders: CollectionConfig = {
-  slug: 'orders',
-  fields: [
-    {
-      name: 'total',
-      type: 'number',
-      required: true,
-    },
-    {
-      name: 'placedBy',
-      type: 'relationship',
-      relationTo: 'customers',
-      required: true,
-    },
-  ],
-}
-```
-
-#### More collection config examples
-
-You can find an assortment
-of [example collection configs](https://github.com/payloadcms/public-demo/tree/master/src/payload/collections) in the
-Public
-Demo source code on GitHub.
-
-### Admin options
-
-You can customize the way that the Admin panel behaves on a collection-by-collection basis by defining the `admin`
-property on a collection's config.
-
-| Option                       | Description                                                                                                                                                                                           |
-|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `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 collection from navigation and admin routing.                                                                 |
-| `hooks`                      | Admin-specific hooks for this collection. [More](#admin-hooks)                                                                                                                                        |
-| `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.                                                |
-| `description`                | Text or React component to display below the Collection label in the List view to give editors more information.                                                                                      |
-| `defaultColumns`             | Array of field names that correspond to which columns to show by default in this collection's List view.                                                                                              |
-| `disableDuplicate `          | Disables the "Duplicate" button while editing documents within this collection.                                                                                                                       |
-| `hideAPIURL`                 | Hides the "API URL" meta field while editing documents within this collection.                                                                                                                        |
-| `enableRichTextLink`         | The [Rich Text](/docs/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.         |
-| `enableRichTextRelationship` | The [Rich Text](/docs/fields/rich-text) field features a `Relationship` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
-| `preview`                    | Function to generate preview URLS within the Admin panel that can point to your app. [More](#preview).                                                                                                |
-| `livePreview`                | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).                                                                              |
-| `components`                 | Swap in your own React components to be used within this collection. [More](/docs/admin/components#collections)                                                                                       |
-| `listSearchableFields`       | Specify which fields should be searched in the List search view. [More](#list-searchable-fields)                                                                                                      |
-| **`pagination`**             | Set pagination-specific options for this collection. [More](#pagination)                                                                                                                              |
-
-### Preview
-
-Collection `admin` options can accept a `preview` function that will be used to generate a link pointing to the frontend
-of your app to preview data.
-
-If the function is specified, a Preview button will automatically appear in the corresponding collection's Edit view.
-Clicking the Preview button will link to the URL that is generated by the function.
-
-**The preview function accepts two arguments:**
-
-1. The document being edited
-1. An `options` object, containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT.
-
-**Example collection with preview function:**
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Posts: CollectionConfig = {
-  slug: 'posts',
-  fields: [
-    {
-      name: 'slug',
-      type: 'text',
-      required: true,
-    },
-  ],
-  admin: {
-    preview: (doc, { locale }) => {
-      if (doc?.slug) {
-        return `https://bigbird.com/preview/posts/${doc.slug}?locale=${locale}`
-      }
-
-      return null
-    },
-  },
-}
-```
-
-### Pagination
-
-Here are a few options that you can specify options for pagination on a collection-by-collection basis:
-
-| Option         | Description                                                                                         |
-|----------------|-----------------------------------------------------------------------------------------------------|
-| `defaultLimit` | Integer that specifies the default per-page limit that should be used. Defaults to 10.              |
-| `limits`       | Provide an array of integers to use as per-page options for admins to choose from in the List view. |
-
-### Access control
-
-You can specify extremely granular access control (what users can do with documents in a collection) on a collection by
-collection basis. To learn more, go to the [Access Control](/docs/access-control/overview) docs.
-
-### Hooks
-
-Hooks are a powerful way to extend collection functionality and execute your own logic, and can be defined on a
-collection by collection basis. To learn more, go to the [Hooks](/docs/hooks/overview) documentation.
-
-### Field types
-
-Collections support all field types that Payload has to offer—including simple fields like text and checkboxes all the
-way to more complicated layout-building field groups like Blocks. [Click here](/docs/fields/overview) to learn more
-about field types.
-
-### List Searchable Fields
-
-In the List view, there is a "search" box that allows you to quickly find a document with a search. By default, it
-searches on the ID field. If you have `admin.useAsTitle` defined, the list search will use that field. However, you can
-define more than one field to search to make it easier on your admin editors to find the data they need.
-
-For example, let's say you have a Posts collection with `title`, `metaDescription`, and `tags` fields - and you want all
-three of those fields to be searchable in the List view. You can simply
-add `admin.listSearchableFields: ['title', 'metaDescription', 'tags']` - and the admin UI will automatically search on
-those three fields plus the ID field.
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  If you are adding <strong>listSearchableFields</strong>, make sure you index each of these fields
-  so your admin queries can remain performant.
-</Banner>
-
-### Admin Hooks
-
-In addition to collection hooks themselves, Payload provides for admin UI-specific hooks that you can leverage.
-
-**`beforeDuplicate`**
-
-The `beforeDuplicate` hook is an async function that accepts an object containing the data to duplicate, as well as the
-locale of the doc to duplicate. Within this hook, you can modify the data to be duplicated, which is useful in cases
-where you have unique fields that need to be incremented or similar, as well as if you want to automatically modify a
-document's `title`.
-
-Example:
-
-```ts
-import { BeforeDuplicate, CollectionConfig } from 'payload/types'
-// Your auto-generated Page type
-import { Page } from '../payload-types.ts'
-
-const beforeDuplicate: BeforeDuplicate<Page> = ({ data }) => {
-  return {
-    ...data,
-    title: `${data.title} Copy`,
-    uniqueField: data.uniqueField ? `${data.uniqueField}-copy` : '',
-  }
-}
-
-export const Page: CollectionConfig = {
-  slug: 'pages',
-  admin: {
-    hooks: {
-      beforeDuplicate,
-    },
-  },
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-    },
-    {
-      name: 'uniqueField',
-      type: 'text',
-      unique: true,
-    },
-  ],
-}
-```
-
-### TypeScript
-
-You can import collection types as follows:
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-// This is the type used for incoming collection configs.
-// Only the bare minimum properties are marked as required.
-```
-
-```ts
-import { SanitizedCollectionConfig } from 'payload/types'
-
-// This is the type used after an incoming collection config is fully sanitized.
-// Generally, this is only used internally by Payload.
-```

docs/configuration/express.mdx

@@ -1,81 +0,0 @@
----
-title: Express
-label: Express
-order: 60
-desc: Payload utilizes Express middleware packages, you can customize how they work by passing in configuration options.
-keywords: config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload utilizes a few Express-specific middleware packages within its own routers. You can customize how they work by passing in configuration options to the main Payload config's `express` property.
-
-### Custom Middleware
-
-Payload allows you to pass in custom Express middleware to be used on all of the routes it opens. This is useful for adding logging or any other custom functionality to your endpoints.
-
-There are 2 exposed properties. Each property is an array of middleware functions.
-
-- `preMiddleware` - runs before any of the Payload middleware
-- `postMiddleware` - runs after all of the Payload middleware
-
-```ts
-{
-  express: {
-    preMiddleware: [
-      (req, res, next) => {
-        // do something
-        next()
-      }
-    ],
-    postMiddleware: [
-      (req, res, next) => {
-        // do something
-        next()
-      }
-    ]
-  }
-}
-
-// Example logging middleware function
-const requestLoggerMiddleware = (req, res, next) => {
-  req.payload.logger.info(`request: ${req.method} ${req.url}`)
-  next()
-}
-```
-
-### JSON
-
-`express.json()` is used to parse JSON body content into JavaScript objects accessible on the Express `req`. Payload allows you to customize all of the `json` method's options. Common examples of customization use-cases are increasing the max allowed JSON body size which defaults to `2MB`.
-
-**Example payload.config.js for how to increase the max JSON size allowed to be sent to Payload endpoints:**
-
-```js
-{
-	express: {
-		json: {
-			limit: '4mb',
-		}
-	}
-}
-```
-
-You can find a list of all available options that are able to be passed to `express.json()` [here](https://expressjs.com/en/api.html).
-
-### Compression
-
-Payload uses the `compression` package to optimize transfer size for all of the routes it opens, and you can pass customization options through the Payload config.
-
-To customize compression options, pass an object to the Payload config's `express` property.
-
-**Example payload.config.js:**
-
-```js
-{
-  express: {
-    compression: {
-      // settings go here
-    }
-  }
-}
-```
-
-Typically, the default options for this package are suitable. However, for a list of all available customization options, [click here](http://expressjs.com/en/resources/middleware/compression.html).

docs/configuration/globals.mdx

@@ -1,156 +0,0 @@
----
-title: Global Configs
-label: Globals
-order: 30
-desc: Set up your Global config for your needs by defining fields, adding slugs and labels, establishing access control, tying in hooks and more.
-keywords: globals, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Global configs are in many ways similar to [Collections](/docs/configuration/collections). The big difference is that
-Collections will potentially contain _many_ documents, while a Global is a "one-off". Globals are perfect for things
-like header nav, site-wide banner alerts, app-wide localized strings, and other "global" data that your site or app
-might rely on.
-
-As with Collection configs, it's often best practice to write your Globals in separate files and then import them into
-the main Payload config.
-
-## Options
-
-| Option             | Description                                                                                                                                                                                                          |
-|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`slug`** \*      | Unique, URL-friendly string that will act as an identifier for this Global.                                                                                                                                          |
-| **`fields`** \*    | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
-| **`label`**        | Text for the name in the Admin panel or an object with keys for each language. Auto-generated from slug if not defined.                                                                                              |
-| **`description`**  | Text or React component to display below the Global header to give editors more information.                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](/docs/configuration/globals#admin-options).                                                                                                                |
-| **`hooks`**        | Entry points to "tie in" to collection actions at specific points. [More](/docs/hooks/overview#global-hooks)                                                                                                         |
-| **`access`**       | Provide access control functions to define exactly who should be able to do what with this Global. [More](/docs/access-control/overview/#globals)                                                                    |
-| **`versions`**     | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#globals-config)                                                                                           |
-| **`endpoints`**    | Add custom routes to the REST API. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                                                  |
-| **`graphQL.name`** | Text used in schema generation. Auto-generated from slug if not defined.                                                                                                                                             |
-| **`typescript`**   | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                  |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                            |
-| **`dbName`**       | Custom table or collection name for this global depending on the database adapter. Auto-generated from slug if not defined.
-
-_\* An asterisk denotes that a property is required._
-
-#### Simple Global example
-
-```ts
-import { GlobalConfig } from 'payload/types'
-
-const Nav: GlobalConfig = {
-  slug: 'nav',
-  fields: [
-    {
-      name: 'items',
-      type: 'array',
-      required: true,
-      maxRows: 8,
-      fields: [
-        {
-          name: 'page',
-          type: 'relationship',
-          relationTo: 'pages', // "pages" is the slug of an existing collection
-          required: true,
-        },
-      ],
-    },
-  ],
-}
-
-export default Nav
-```
-
-#### Global config example
-
-You can find a few [example Global configs](https://github.com/payloadcms/public-demo/tree/master/src/payload/globals)
-in the Public Demo source code on GitHub.
-
-### Admin options
-
-You can customize the way that the Admin panel behaves on a Global-by-Global basis by defining the `admin` property on a
-Global's config.
-
-| Option        | Description                                                                                                                       |
-|---------------|-----------------------------------------------------------------------------------------------------------------------------------|
-| `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](/docs/admin/components#globals)                           |
-| `preview`     | Function to generate a preview URL within the Admin panel for this global that can point to your app. [More](#preview).           |
-| `livePreview` | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).          |
-| `hideAPIURL`  | Hides the "API URL" meta field while editing documents within this collection.                                                    |
-
-### Preview
-
-Global `admin` options can accept a `preview` function that will be used to generate a link pointing to the frontend of
-your app to preview data.
-
-If the function is specified, a Preview button will automatically appear in the corresponding global's Edit view.
-Clicking the Preview button will link to the URL that is generated by the function.
-
-**The preview function accepts two arguments:**
-
-1. The document being edited
-1. An `options` object, containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT.
-
-**Example global with preview function:**
-
-```ts
-import { GlobalConfig } from 'payload/types'
-
-export const MyGlobal: GlobalConfig = {
-  slug: 'my-global',
-  fields: [
-    {
-      name: 'slug',
-      type: 'text',
-      required: true,
-    },
-  ],
-  admin: {
-    preview: (doc, { locale }) => {
-      if (doc?.slug) {
-        return `https://bigbird.com/preview/${doc.slug}?locale=${locale}`
-      }
-
-      return null
-    },
-  },
-}
-```
-
-### Access control
-
-As with Collections, you can specify extremely granular access control (what users can do with this Global) on a
-Global-by-Global basis. However, Globals only have `update` and `read` access control due to their nature of only having
-one document. To learn more, go to the [Access Control](/docs/access-control/overview) docs.
-
-### Hooks
-
-Globals also fully support a smaller subset of Hooks. To learn more, go to the [Hooks](/docs/hooks/overview)
-documentation.
-
-### Field types
-
-Globals support all field types that Payload has to offer—including simple fields like text and checkboxes all the way
-to more complicated layout-building field groups like Blocks. [Click here](/docs/fields/overview) to learn more about
-field types.
-
-### TypeScript
-
-You can import global types as follows:
-
-```ts
-import { GlobalConfig } from 'payload/types'
-
-// This is the type used for incoming global configs.
-// Only the bare minimum properties are marked as required.
-```
-
-```ts
-import { SanitizedGlobalConfig } from 'payload/types'
-
-// This is the type used after an incoming global config is fully sanitized.
-// Generally, this is only used internally by Payload.
-```

docs/configuration/i18n.mdx

@@ -1,110 +0,0 @@
----
-title: I18n
-label: I18n
-order: 40
-desc: Manage and customize internationalization support in your CMS editor experience
-keywords: internationalization, i18n, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Not only does Payload support managing localized content, it also has internationalization support so that admin users can work in their preferred language. Payload's i18n support is built on top of [i18next](https://www.i18next.com). It comes included by default and can be extended in your config.
-
-While Payload's built-in features come translated, you may want to also translate parts of your project's configuration too. This is possible in places like collections and globals labels and groups, field labels, descriptions and input placeholder text. The admin UI will display all the correct translations you provide based on the user's language.
-
-Here is an example of a simple collection supporting both English and Spanish editors:
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Articles: CollectionConfig = {
-  slug: 'articles',
-  labels: {
-    singular: {
-      en: 'Article',
-      es: 'Artículo',
-    },
-    plural: {
-      en: 'Articles',
-      es: 'Artículos',
-    },
-  },
-  admin: {
-    group: { en: 'Content', es: 'Contenido' },
-  },
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-      label: {
-        en: 'Title',
-        es: 'Título',
-      },
-      admin: {
-        placeholder: { en: 'Enter title', es: 'Introduce el título' },
-      },
-    },
-    {
-      name: 'type',
-      type: 'radio',
-      options: [
-        {
-          value: 'news',
-          label: { en: 'News', es: 'Noticias' },
-        }, // etc...
-      ],
-    },
-  ],
-}
-```
-
-### Admin UI
-
-The Payload admin panel reads the language settings of a user's browser and display all text in that language, or will fall back to English if the user's language is not yet supported.
-After a user logs in, they can change their language selection in the `/account` view.
-
-<Banner>
-  <strong>Note:</strong>
-  <br />
-  If there is a language that Payload does not yet support, we accept code
-  [contributions](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md).
-</Banner>
-
-### Node Express
-
-Payload's backend uses express middleware to set the language on incoming requests before they are handled. This allows backend validation to return error messages in the user's own language or system generated emails to be sent using the correct translation. You can make HTTP requests with the `accept-language` header and Payload will use that language.
-
-Anywhere in your Payload app that you have access to the `req` object, you can access i18next's extensive internationalization features assigned to `req.i18n`. To access text translations you can use `req.t('namespace:key')`.
-
-Read the i18next [API documentation](https://www.i18next.com/overview/api) to learn more.
-
-### Configuration Options
-
-In your Payload config, you can add translations and customize the settings in `i18n`. Payload will use your custom options and merge it with the default, allowing you to override the settings Payload provides.
-
-**Example Payload config extending i18n:**
-
-```ts
-import { buildConfig } from 'payload/config'
-
-export default buildConfig({
-  //...
-  i18n: {
-    fallbackLng: 'en', // default
-    debug: false, // default
-    resources: {
-      en: {
-        custom: {
-          // namespace can be anything you want
-          key1: 'Translation with {{variable}}', // translation
-        },
-        // override existing translation keys
-        general: {
-          dashboard: 'Home',
-        },
-      },
-    },
-  },
-  //...
-})
-```
-
-See the i18next [configuration options](https://www.i18next.com/overview/configuration-options) to learn more.

docs/configuration/localization.mdx

@@ -1,243 +0,0 @@
----
-title: Localization
-label: Localization
-order: 50
-desc: Add and maintain as many locales as you need by adding Localization to your Payload config, set options for default locale, fallbacks, fields and more.
-keywords: localization, internationalization, i18n, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload features deep field-based localization support. Maintaining as many locales as you need is easy. All
-localization support is opt-in by default. To do so, follow the two steps below.
-
-### Enabling in the Payload config
-
-Add the `localization` property to your Payload config to enable localization project-wide. You'll need to provide a
-list of all locales that you'd like to support as well as set a few other options.
-
-**Example Payload config set up for localization:**
-
-```ts
-import { buildConfig } from 'payload/config'
-
-export default buildConfig({
-  collections: [
-    // collections go here
-  ],
-  localization: {
-    locales: ['en', 'es', 'de'],
-    defaultLocale: 'en',
-    fallback: true,
-  },
-})
-```
-
-**Example Payload config set up for localization with full locales objects:**
-
-```ts
-import { buildConfig } from 'payload/config'
-
-export default buildConfig({
-  collections: [
-    // collections go here
-  ],
-  localization: {
-    locales: [
-      {
-        label: 'English',
-        code: 'en',
-      },
-      {
-        label: 'Arabic',
-        code: 'ar',
-        // opt-in to setting default text-alignment on Input fields to rtl (right-to-left)
-        // when current locale is rtl
-        rtl: true,
-      },
-    ],
-    defaultLocale: 'en',
-    fallback: true,
-  },
-})
-```
-
-**Example Payload config set up for localization with full locales objects (
-including [internationalization](/docs/configuration/i18n) support):**
-
-```ts
-import { buildConfig } from 'payload/config'
-
-export default buildConfig({
-  collections: [
-    // collections go here
-  ],
-  localization: {
-    locales: [
-      {
-        label: {
-          en: 'English', // English label
-          nb: 'Engelsk', // Norwegian label
-        },
-        code: 'en',
-      },
-      {
-        label: {
-          en: 'Norwegian', // English label
-          nb: 'Norsk', // Norwegian label
-        },
-        code: 'nb',
-      },
-    ],
-    defaultLocale: 'en',
-    fallback: true,
-  },
-})
-```
-
-**Here is a brief explanation of each of the options available within the `localization` property:**
-
-**`locales`**
-
-Array-based list of all the languages that you would like to support. This can be an array containing strings for each
-language code you want your project to store and serve or objects with a `label`, a locale `code`, `rtl` (
-right-to-left), and `fallbackLocale` property. The locale codes do not need to be in any specific format. It's up to you
-to define how to represent your locales. Common patterns are to use two-letter ISO 639 language codes or four-letter
-language and country codes (ISO 3166‑1) such as `en-US`, `en-UK`, `es-MX`, etc.
-
-### Locale Properties:
-
-| Option               | Description                                                                                                                    |
-|----------------------|--------------------------------------------------------------------------------------------------------------------------------|
-| **`code`** \*        | Unique code to identify the language throughout the APIs for `locale` and `fallbackLocale`                                     |
-| **`label`**          | A string to use for the selector when choosing a language, or an object keyed on the i18n keys for different languages in use. |
-| **`rtl`**            | A boolean that when true will make the admin UI display in Right-To-Left.                                                      |
-| **`fallbackLocale`** | The code for this language to fallback to when properties of a document are not present.                                       |
-
-_\* An asterisk denotes that a property is required._
-
-**`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.
-
-### Field by field localization
-
-Payload localization works on a **field** level—not a document level. In addition to configuring the base Payload config
-to support localization, you need to specify each field that you would like to localize.
-
-**Here is an example of how to enable localization for a field:**
-
-```js
-{
-  name: 'title',
-  type: 'text',
-  // highlight-start
-  localized: true,
-  // highlight-end
-}
-```
-
-With the above configuration, the `title` field will now be saved in the database as an object of all locales instead of
-a single string.
-
-All field types with a `name` property support the `localized` property—even the more complex field types like `array`s
-and `block`s.
-
-<Banner>
-  <strong>Note:</strong>
-  <br />
-  Enabling localization for field types that support nested fields will automatically create
-  localized "sets" of all fields contained within the field. For example, if you have a page layout
-  using a blocks field type, you have the choice of either localizing the full layout, by enabling
-  localization on the top-level blocks field, or only certain fields within the layout.
-</Banner>
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  When converting an existing field to or from `localized: true` the data structure in the document
-  will change for this field and so existing data for this field will be lost. Before changing the
-  localization setting on fields with existing data, you may need to consider a field migration
-  strategy.
-</Banner>
-
-### Retrieving localized docs
-
-When retrieving documents, you can specify which locale you'd like to receive as well as which fallback locale should be
-used.
-
-##### REST API
-
-REST API locale functionality relies on URL query parameters.
-
-**`?locale=`**
-
-Specify your desired locale by providing the `locale` query parameter directly in the endpoint URL.
-
-**`?fallback-locale=`**
-
-Specify fallback locale to be used by providing the `fallback-locale` query parameter. This can be provided as either a
-valid locale as provided to your base Payload config, or `'null'`, `'false'`, or `'none'` to disable falling back.
-
-**Example:**
-
-```
-fetch('https://localhost:3000/api/pages?locale=es&fallback-locale=none');
-```
-
-##### GraphQL API
-
-In the GraphQL API, you can specify `locale` and `fallbackLocale` args to all relevant queries and mutations.
-
-The `locale` arg will only accept valid locales, but locales will be formatted automatically as valid GraphQL enum
-values (dashes or special characters will be converted to underscores, spaces will be removed, etc.). If you are curious
-to see how locales are auto-formatted, you can use the [GraphQL playground](/docs/graphql/overview#graphql-playground).
-
-The `fallbackLocale` arg will accept valid locales as well as `none` to disable falling back.
-
-**Example:**
-
-```graphql
-query {
-    Posts(locale: de, fallbackLocale: none) {
-        docs {
-            title
-        }
-    }
-}
-```
-
-<Banner>
-  In GraphQL, specifying the locale at the top level of a query will automatically apply it
-  throughout all nested relationship fields. You can override this behavior by re-specifying locale
-  arguments in nested related document queries.
-</Banner>
-
-##### Local API
-
-You can specify `locale` as well as `fallbackLocale` within the Local API as well as properties on the `options`
-argument. The `locale` property will accept any valid locale, and the `fallbackLocale` property will accept any valid
-locale as well as `'null'`, `'false'`, `false`, and `'none'`.
-
-**Example:**
-
-```js
-const posts = await payload.find({
-  collection: 'posts',
-  locale: 'es',
-  fallbackLocale: false,
-})
-```
-
-<Banner type="alert">
-  <strong>Tip:</strong>
-  <br />
-  The REST and Local APIs can return all localization data in one request by passing 'all' or '*' as
-  the <strong>locale</strong> parameter. The response will be structured so that field values come
-  back as the full objects keyed for each locale instead of the single, translated value.
-</Banner>

docs/configuration/overview.mdx

@@ -1,197 +0,0 @@
----
-title: The Payload Config
-label: Overview
-order: 10
-desc: The Payload config is central to everything that Payload does, from adding custom React components, to modifying collections, controlling localization and much more.
-keywords: overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload is a _config-based_, code-first CMS and application framework. The Payload config is central to everything that Payload does. It scaffolds the data that Payload stores as well as maintains custom React components, hook logic, custom validations, and much more.
-
-**Also, because the Payload source code is fully written in TypeScript, its configs are strongly typed—meaning that even if you aren't using TypeScript, your IDE (such as VSCode) may still provide helpful information like type-ahead suggestions while you write your config.**
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  This file is included in the Payload admin bundle, so make sure you do not embed any sensitive
-  information.
-</Banner>
-
-## Options
-
-| Option                | Description                                                                                                                                                                       |
-| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `admin` \*            | Base Payload admin configuration. Specify bundler*, custom components, control metadata, set the Admin user collection, and [more](/docs/admin/overview#admin-options). Required. |
-| `editor` \*           | Rich Text Editor which will be used by richText fields. Required.                                                                                                                 |
-| `db` \*               | Database Adapter which will be used by Payload. Read more [here](/docs/database/overview). Required.                                                                              |
-| `serverURL`           | A string used to define the absolute URL of your app including the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port     |
-| `collections`         | An array of all Collections that Payload will manage. To read more about how to define your collection configs, [click here](/docs/configuration/collections).                    |
-| `globals`             | An array of all Globals that Payload will manage. For more on Globals and their configs, [click here](/docs/configuration/globals).                                               |
-| `cors`                | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain.                                           |
-| `localization`        | Opt-in and control how Payload handles the translation of your content into multiple locales. [More](/docs/configuration/localization)                                            |
-| `graphQL`             | Manage GraphQL-specific functionality here. Define your own queries and mutations, manage query complexity limits, and [more](/docs/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 cookies to be accepted from as a form of CSRF protection. [More](/docs/authentication/overview#csrf-protection)                        |
-| `defaultDepth`        | If a user does not specify `depth` while requesting a resource, this depth will be used. [More](/docs/getting-started/concepts#depth)                                             |
-| `maxDepth`            | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`.                                               |
-| `indexSortableFields` | Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar.                        |
-| `upload`              | Base Payload upload configuration. [More](/docs/upload/overview#payload-wide-upload-options).                                                                                     |
-| `routes`              | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`.                                                           |
-| `email`               | Base email settings to allow Payload to generate email such as Forgot Password requests and other requirements. [More](/docs/email/overview#configuration)                        |
-| `express`             | Express-specific middleware options such as compression and JSON parsing. [More](/docs/configuration/express)                                                                     |
-| `debug`               | Enable to expose more detailed error information.                                                                                                                                 |
-| `telemetry`           | Disable Payload telemetry by passing `false`. [More](/docs/configuration/overview#telemetry)                                                                                      |
-| `rateLimit`           | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks and [more](/docs/production/preventing-abuse#rate-limiting-requests).                      |
-| `hooks`               | Tap into Payload-wide hooks. [More](/docs/hooks/overview)                                                                                                                         |
-| `plugins`             | An array of Payload plugins. [More](/docs/plugins/overview)                                                                                                                       |
-| `endpoints`           | An array of custom API endpoints added to the Payload router. [More](/docs/rest-api/overview#custom-endpoints)                                                                    |
-| `custom`              | Extension point for adding custom data (e.g. for plugins)                                                                                                                         |
-
-_\* An asterisk denotes that a property is required._
-
-#### Simple example
-
-```ts
-import { buildConfig } from 'payload/config'
-import { mongooseAdapter } from '@payloadcms/db-mongodb'
-import { postgresAdapter } from '@payloadcms/db-postgres' // beta
-
-import { viteBundler } from '@payloadcms/bundler-vite'
-import { webpackBundler } from '@payloadcms/bundler-webpack'
-
-import { lexicalEditor } from '@payloadcms/richtext-lexical' // beta
-import { slateEditor } from '@payloadcms/richtext-slate'
-
-export default buildConfig({
-  admin: {
-    bundler: webpackBundler(), // or viteBundler()
-  },
-  db: mongooseAdapter({}) // or postgresAdapter({}),
-  editor: lexicalEditor({}) // or slateEditor({})
-  collections: [
-    {
-      slug: 'pages',
-      fields: [
-        {
-          name: 'title',
-          type: 'text',
-          required: true,
-        },
-        {
-          name: 'content',
-          type: 'richText',
-          required: true,
-        },
-      ],
-    },
-  ],
-  globals: [
-    {
-      slug: 'header',
-      fields: [
-        {
-          name: 'nav',
-          type: 'array',
-          fields: [
-            {
-              name: 'page',
-              type: 'relationship',
-              relationTo: 'pages',
-            },
-          ],
-        },
-      ],
-    },
-  ],
-})
-```
-
-#### Full example config
-
-You can see a full [example config](https://github.com/payloadcms/public-demo/blob/master/src/payload/payload.config.ts) in the Public Demo source code on GitHub.
-
-### Using environment variables in your config
-
-We suggest using the `dotenv` package to handle environment variables alongside of Payload. All that's necessary to do is to require the package as high up in your application as possible (for example, at the top of your `server.js` file), and ensure that it can find an `.env` file that you create.
-
-**Add this line to the top of your server:**
-
-```
-require('dotenv').config()
-// ...
-// the rest of your `server.js` file goes here
-```
-
-Note that if you rely on any environment variables in your config itself, you should also call `dotenv()` at the top of your config itself as well. There's no harm in calling it in both your server and your config itself!
-
-**Here is an example project structure w/ `dotenv` and an `.env` file:**
-
-```
-project-name
----- .env
----- package.json
----- payload.config.js
----- server.js
-```
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  If you use an environment variable to configure any properties that are required for the Admin
-  panel to function (ex. serverURL or any routes), you need to make sure that your Admin panel code
-  can access it. [Click here](/docs/admin/webpack#admin-environment-vars) for more info.
-</Banner>
-
-### Customizing & Automating Config Location Detection
-
-Payload is designed to automatically locate your configuration file. By default, it will first look in the root of your current working directory for a file named `payload.config.js` or `payload.config.ts` if you're using TypeScript.
-
-In development mode, if the configuration file is not found at the root, Payload will attempt to read your `tsconfig.json`, and search in the directory specified in `compilerOptions.rootDir` (typically "src").
-
-In production mode, Payload will first attempt to find the config file in the output directory specified in `compilerOptions.outDir` of your `tsconfig.json`, then fallback to the source directory (`compilerOptions.rootDir`), and finally will check the 'dist' directory.
-
-Please ensure your `tsconfig.json` is properly configured if you want Payload to accurately auto-detect your configuration file location. If `tsconfig.json` does not exist or doesn't specify `rootDir` or `outDir`, Payload will default to the current working directory.
-
-#### Overriding the Config Location
-
-In addition to the above automated detection, you can specify your own location for the Payload config file. This is done by using the environment variable `PAYLOAD_CONFIG_PATH`. The path you provide via this environment variable can either be absolute or relative to your current working directory. This can be useful in situations where your Payload config is not in a standard location, or you wish to switch between multiple configurations.
-
-**Example in package.json:**
-
-```json
-{
-  "scripts": {
-    "dev": "PAYLOAD_CONFIG_PATH=path/to/custom-config.js node server.js"
-  }
-}
-```
-
-When `PAYLOAD_CONFIG_PATH` is set, Payload will use this path to load the configuration, bypassing all automated detection.
-
-### Developing within the Config
-
-Payload comes with `isomorphic-fetch` installed which means that even in Node, you can use the `fetch` API just as you would within the browser. No need to import `axios` or similar, unless you want to!
-
-### TypeScript
-
-You can import config types as follows:
-
-```ts
-import { Config } from 'payload/config'
-
-// This is the type used for an incoming Payload config.
-// Only the bare minimum properties are marked as required.
-```
-
-```ts
-import { SanitizedConfig } from 'payload/config'
-
-// This is the type used after an incoming Payload config is fully sanitized.
-// Generally, this is only used internally by Payload.
-```
-
-### Telemetry
-
-Payload collects **completely anonymous** telemetry data about general usage. This data is super important to us and helps us accurately understand how we're growing and what we can do to build the software into everything that it can possibly be. The telemetry that we collect also help us demonstrate our growth in an accurate manner, which helps us as we seek investment to build and scale our team. If we can accurately demonstrate our growth, we can more effectively continue to support Payload as free and open-source software. To opt out of telemetry, you can pass `telemetry: false` within your Payload config.
-
-For more information about what we track, take a look at our [privacy policy](/privacy).

docs/database/migrations.mdx

@@ -1,125 +0,0 @@
----
-title: Migrations
-label: Migrations
-order: 20
-keywords: database, migrations, ddl, sql, mongodb, postgres, documentation, Content Management System, cms, headless, typescript, node, react, express
-desc: Payload features first-party database migrations all done in TypeScript.
----
-
-Payload exposes a full suite of migration controls available for your use. Migration commands are accessible via
-the `npm run payload` command in your project directory.
-
-Ensure you have an npm script called "payload" in your `package.json` file.
-
-```json
-{
-  "scripts": {
-    "payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload"
-  }
-}
-```
-
-<Banner>
-  Note that you need to run Payload migrations through the package manager that you are using, because Payload should not be globally installed on your system.
-</Banner>
-
-### Migration file contents
-
-Payload stores all created migrations in a folder that you can specify. By default, migrations are stored
-in `./src/migrations`.
-
-A migration file has two exports - an `up` function, which is called when a migration is executed, and a `down` function
-that will be called if for some reason the migration fails to complete successfully. The `up` function should contain
-all changes that you attempt to make within the migration, and the `down` should ideally revert any changes you make.
-
-For an added level of safety, migrations should leverage Payload [transactions](/docs/database/transactions). Migration
-functions should make use of the `req` by adding it to the arguments of your payload local API calls such
-as `payload.create` and database adapter methods like `payload.db.create`.
-
-Here is an example migration file:
-
-```ts
-import { MigrateUpArgs, MigrateDownArgs } from '@payloadcms/your-db-adapter'
-
-export async function up ({ payload, req }: MigrateUpArgs): Promise<void> {
-  // Perform changes to your database here.
-  // You have access to `payload` as an argument, and
-  // everything is done in TypeScript.
-};
-
-export async function down ({ payload, req }: MigrateDownArgs): Promise<void> {
-  // Do whatever you need to revert changes if the `up` function fails
-};
-```
-
-### Migrations Directory
-
-Each DB adapter has an optional property `migrationDir` where you can override where you want your migrations to be
-stored/read. If this is not specified, Payload will check the default and possibly make a best effort to find your
-migrations directory by searching in common locations ie. `./src/migrations`, `./dist/migrations`, `./migrations`, etc.
-
-All database adapters should implement similar migration patterns, but there will be small differences based on the
-adapter and its specific needs. Below is a list of all migration commands that should be supported by your database
-adapter.
-
-## Commands
-
-### Migrate
-
-The `migrate` command will run any migrations that have not yet been run.
-
-```text
-npm run payload migrate
-```
-
-### Create
-
-Create a new migration file in the migrations directory. You can optionally name the migration that will be created. By
-default, migrations will be named using a timestamp.
-
-```text
-npm run payload migrate:create optional-name-here
-```
-
-### Status
-
-The `migrate:status` command will check the status of migrations and output a table of which migrations have been run,
-and which migrations have not yet run.
-
-`payload migrate:status`
-
-```text
-npm run payload migrate:status
-```
-
-### Down
-
-Roll back the last batch of migrations.
-
-```text
-npm run payload migrate:down
-```
-
-### Refresh
-
-Roll back all migrations that have been run, and run them again.
-
-```text
-npm run payload migrate:refresh
-```
-
-### Reset
-
-Roll back all migrations.
-
-```text
-npm run payload migrate:reset
-```
-
-### Fresh
-
-Drops all entities from the database and re-runs all migrations from scratch.
-
-```text
-npm run payload migrate:fresh
-```

docs/database/mongodb.mdx

@@ -1,50 +0,0 @@
----
-title: MongoDB
-label: MongoDB
-order: 40
-desc: Payload has supported MongoDB natively since we started. The flexible nature of MongoDB lends itself well to Payload's powerful fields.
-keywords: MongoDB, documentation, typescript, Content Management System, cms, headless, javascript, node, react, express
----
-
-To use Payload with MongoDB, install the package `@payloadcms/db-mongodb`. It will come with everything you need to
-store your Payload data in MongoDB.
-
-Then from there, pass it to your Payload config as follows:
-
-```ts
-import { mongooseAdapter } from '@payloadcms/db-mongodb'
-
-export default buildConfig({
-  // Your config goes here
-  collections: [
-    // Collections go here
-  ],
-  // Configure the Mongoose adapter here
-  db: mongooseAdapter({
-    // Mongoose-specific arguments go here.
-    // URL is required.
-    url: process.env.DATABASE_URI,
-  }),
-})
-```
-
-### Options
-
-| Option               | Description                                                                                                                                                                                                                                                                                   |
-|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `autoPluralization`  | Tell Mongoose to auto-pluralize any collection names if it encounters any singular words used as collection `slug`s.                                                                                                                                                                          |
-| `connectOptions`     | Customize MongoDB connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose.                                         |
-| `disableIndexHints`  | Set to true to disable hinting to MongoDB to use 'id' as index. This is currently done when counting documents for pagination, as it increases the speed of the count function used in that query. Disabling this optimization might fix some problems with AWS DocumentDB. Defaults to false |
-| `migrationDir`       | Customize the directory that migrations are stored.                                                                                                                                                                                                                                           |
-| `transactionOptions` | An object with configuration properties used in [transactions](https://www.mongodb.com/docs/manual/core/transactions/) or `false` which will disable the use of transactions.                                                                                                                 |                                                                                                                                                                                                                                                                     |
-
-### Access to Mongoose models
-
-After Payload is initialized, this adapter exposes all of your Mongoose models and they are available for you to work
-with directly.
-
-You can access Mongoose models as follows:
-
-- Collection models - `payload.db.collections[myCollectionSlug]`
-- Globals model - `payload.db.globals`
-- Versions model (both collections and globals) - `payload.db.versions[myEntitySlug]`

docs/database/overview.mdx

@@ -1,73 +0,0 @@
----
-title: Database
-label: Overview
-order: 10
-keywords: database, mongodb, postgres, documentation, Content Management System, cms, headless, typescript, node, react, express
-desc: With Payload, you bring your own database and own your data. You have full control.
----
-
-Payload interacts with your database via the database adapter that you choose. Right now, Payload officially supports two database adapters:
-
-1. [MongoDB](/docs/database/mongodb) w/ [Mongoose](https://mongoosejs.com/)
-1. [Postgres](/docs/database/postgres) w/ [Drizzle](https://drizzle.team/)
-
-We will be adding support for SQLite and MySQL in the near future using Drizzle ORM.
-
-To use a specific database adapter, you need to install it and configure it according to its own specifications. Visit the documentation for your applicable database adapter to learn more.
-
-## Selecting a database
-
-There are several factors to consider when choosing which database technology and hosting option is right for your project and workload. Payload can theoretically support any database, but it's up to you to decide which database to use.
-
-#### When to use MongoDB
-
-If your project has a lot of dynamic fields, and you are comfortable with allowing Payload to enforce data integrity across your documents, MongoDB is a great choice. With it, your Payload documents are stored as _one_ document in your database—no matter if you have localization enabled, how many block or array fields you have, etc. This means that the shape of your data in your database will very closely reflect your field schema, and there is minimal complexity involved in storing or retrieving your data.
-
-You should prefer MongoDB if:
-
-- You prefer simplicity within your database
-- You don't want to deal with keeping production / staging databases in sync via [DDL changes](https://en.wikipedia.org/wiki/Data_definition_language)
-- Most (or everything) in your project is localized
-- You leverage a lot of array fields, block fields, or `hasMany` select fields and similar
-
-#### When to use a relational DB
-
-Many projects might call for more rigid database architecture where the shape of your data is strongly enforced at the database level. For example, if you know the shape of your data and it's relatively "flat", and you don't anticipate it to change often, your workload might suit relational databases like Postgres very well.
-
-You should prefer a relational DB like Postgres if:
-
-- You are comfortable with migration workflows
-- You require enforced data consistency at the database level
-- You have a lot of relationships between collections and require relationships to be enforced
-
-#### Differences in Payload features
-
-It's important to note that almost everything Payload does is available in all of our officially supported database adapters, including localization, arrays, 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 up to you to choose which database you would like to use.
-
-## Configuration
-
-To configure the database for your Payload application, an adapter can be assigned to `config.db`. This property is required within your Payload config. 
-
-Here's an example:
-
-```ts
-import { postgresAdapter } from '@payloadcms/db-postgres'
-
-export default buildConfig({
-  // Your config goes here
-  collections: [
-    // Collections go here
-  ],
-  // Here is where you pass your database adapter
-  // and the adapter will require options specific to itself
-  db: postgresAdapter({
-    pool: {
-      connectionString: process.env.DATABASE_URI,
-    }
-  }),
-})
-```

docs/database/postgres.mdx

@@ -1,94 +0,0 @@
----
-title: Postgres
-label: Postgres
-order: 50
-desc: Payload supports Postgres through an officially supported Drizzle database adapter.
-keywords: Postgres, documentation, typescript, Content Management System, cms, headless, javascript, node, react, express
----
-
-To use Payload with Postgres, install the package `@payloadcms/db-postgres`. It leverages Drizzle ORM and `node-postgres` to interact with a Postgres database that you provide.
-
-<Banner>
-  The Postgres database adapter is currently in beta. If you would like to help us test this package, we'd love to hear if you find any bugs or issues!
-</Banner>
-
-It automatically manages changes to your database for you in development mode, and exposes a full suite of migration controls for you to leverage in order to keep other database environments in sync with your schema. DDL transformations are automatically generated.
-
-To configure Payload to use Postgres, pass the `postgresAdapter` to your Payload config as follows:
-
-```ts
-import { postgresAdapter } from '@payloadcms/db-postgres'
-
-export default buildConfig({
-  // Your config goes here
-  collections: [
-    // Collections go here
-  ],
-  // Configure the Postgres adapter here
-  db: postgresAdapter({
-    // Postgres-specific arguments go here.
-    // `pool` is required.
-    pool: {
-      connectionString: process.env.DATABASE_URI,
-    }
-  }),
-})
-```
-
-### Options
-
-| Option                | Description                                                                                                                                                                                           |
-|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `pool` \*             | [Pool connection options](https://orm.drizzle.team/docs/quick-postgresql/node-postgres) that will be passed to Drizzle and `node-postgres`.                                                           |
-| `push`                | Disable Drizzle's [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push) in development mode. By default, `push` is enabled for development mode only.                      |
-| `migrationDir`        | Customize the directory that migrations are stored.                                                                                                                                                   |
-| `logger`              | The instance of the logger to be passed to drizzle. By default Payload's will be used.                                                                                                                |
-| `schemaName`   | A string for the postgres schema to use, defaults to 'public'.                                                                                                                   |
-| `localesSuffix`       | A string appended to the end of table names for storing localized fields. Default is '_locales'.                                                                                                      |
-| `relationshipsSuffix` | A string appended to the end of table names for storing relationships. Default is '_rels'.                                                                                                            |
-| `versionsSuffix`      | A string appended to the end of table names for storing versions. Defaults to '_v'.                                                                                                                   |
-
-
-
-### Access to Drizzle
-
-After Payload is initialized, this adapter will expose the full power of Drizzle to you for use if you need it.
-
-You can access Drizzle as follows:
-
-```text
-payload.db.drizzle
-```
-
-### Tables, relations, and enums
-
-In addition to exposing Drizzle directly, all of the tables, Drizzle relations, and enum configs are exposed for you via the `payload.db` property as well.
-
-- Tables - `payload.db.tables`
-- Enums - `payload.db.enums`
-- Relations - `payload.db.relations`
-
-### Prototyping in development mode
-
-Drizzle exposes two ways to work locally in development mode.
-
-The first is [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push), which automatically pushes changes you make to your Payload config (and therefore, Drizzle schema) to your database so you don't have to manually migrate every time you change your Payload config. This only works in development mode, and should not be mixed with manually running [`migrate`](/docs/database/migrations) commands.
-
-You will be warned if any changes that you make will entail data loss while in development mode. Push is enabled by default, but you can opt out if you'd like.
-
-Alternatively, you can disable `push` and rely solely on migrations to keep your local database in sync with your Payload config.
-
-### Migration workflows
-
-Migrations are extremely powerful thanks to the seamless way that Payload and Drizzle work together. Let's take the following scenario:
-
-1. You are building your Payload config locally, with a local database used for testing.
-1. You have left the default setting of `push` enabled, so every time you change your Payload config (add or remove fields, collections, etc.), Drizzle will automatically push changes to your local DB.
-1. Once you're done with your changes, or have completed a feature, you can run `npm run payload migrate:create`.
-1. Payload and Drizzle will look for any existing migrations, and automatically generate all SQL changes necessary to convert your schema from its prior state into the state of your current Payload config, and store the resulting DDL in a newly created migration.
-1. Once you're ready to go to production, you will be able to run `npm run payload migrate` against your production database, which will apply any new migrations that have not yet run.
-1. Now your production database is in sync with your Payload config!
-
-<Banner type="warning">
-  Warning: do not mix "push" and migrations with your local development database. If you use "push" locally, and then try to migrate, Payload will throw a warning, telling you that these two methods are not meant to be used interchangeably.
-</Banner>

docs/database/transactions.mdx

@@ -1,104 +0,0 @@
----
-title: Transactions
-label: Transactions
-order: 30
-keywords: database, transactions, sql, mongodb, postgres, documentation, Content Management System, cms, headless, typescript, node, react, express
-desc: Database transactions are fully supported within Payload.
----
-
-Database transactions allow your application to make a series of database changes in an all-or-nothing commit. Consider an HTTP request that creates a new **Order** and has an `afterChange` hook to update the stock count of related **Items**. If an error occurs when updating an **Item** and an HTTP error is returned to the user, you would not want the new **Order** to be persisted or any other items to be changed either. This kind of interaction with the database is handled seamlessly with transactions.
-
-By default, Payload will use transactions for all operations, as long as it is supported by the configured database. Database changes are contained within all Payload operations and any errors thrown will result in all changes being rolled back without being committed. When transactions are not supported by the database, Payload will continue to operate as expected without them.
-
-<Banner type="info">
-  <strong>Note:</strong>
-  <br />
-  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:
-
-```ts
-const afterChange: CollectionAfterChangeHook = async ({ req }) => {
-  // because req.transactionID is assigned from Payload and passed through,
-  // my-slug will only persist if the entire request is successful
-  await req.payload.create({
-    req,
-    collection: 'my-slug',
-    data: {
-      some: 'data',
-    },
-  })
-}
-```
-
-### Async Hooks with Transactions
-
-Since Payload hooks can be async and be written to not await the result, it is possible to have an incorrect success response returned on a request that is rolled back. If you have a hook where you do not `await` the result, then you should **not** pass the `req.transactionID`.
-
-```ts
-const afterChange: CollectionAfterChangeHook = async ({ req }) => {
-  // WARNING: an async call made with the same req, but NOT awaited,
-  // may fail resulting in an OK response being returned with response data that is not committed
-  const dangerouslyIgnoreAsync = req.payload.create({
-    req,
-    collection: 'my-slug',
-    data: {
-      some: 'other data',
-    },
-  })
-
-  // Should this call fail, it will not rollback other changes
-  // because the req (and its transactionID) is not passed through
-  const safelyIgnoredAsync = req.payload.create({
-    collection: 'my-slug',
-    data: {
-      some: 'other data',
-    },
-  })
-}
-```
-
-### Direct Transaction Access
-
-When writing your own scripts or custom endpoints, you may wish to have direct control over transactions. This is useful for interacting with your database in something like a background job, outside the normal request-response flow.
-
-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. Note that if your database does not support transactions, this will return `null`.\
-`payload.db.commitTransaction` - Takes the identifier for the transaction, finalizes any changes.\
-`payload.db.rollbackTransaction` - Takes the identifier for the transaction, discards any changes.
-
-You can then use the transaction ID with Payload's local API by passing it inside the `PayloadRequest` object.
-
-Here is an example for a "background job" function, which utilizes the direct transaction API to make sure it either succeeds completely or gets rolled back in case of an error.
-
-```ts
-async function allOrNothingJob() {
-    const req = {} as PayloadRequest;
-    req.transactionID = await payload.db.beginTransaction();
-    try {
-      await payload.create({
-        req, // use our manual transaction
-        collection: 'my-slug',
-        data: {
-          some: 'data'
-        }
-      });
-
-      await payload.create({
-        req, // use our manual transaction
-        collection: 'something-else',
-        data: {
-          some: 'data'
-        }
-      });
-      console.log('Everything done.');
-      if (req.transactionID) await payload.db.commitTransaction(req.transactionID);
-    } catch (e) {
-      console.error('Oh no, something went wrong!');
-      if (req.transactionID) await payload.db.rollbackTransaction(req.transactionID);
-    }
-
-}
-```

docs/email/overview.mdx

@@ -1,167 +0,0 @@
----
-title: Email Functionality
-label: Overview
-order: 10
-desc: Payload uses NodeMailer to allow you to send emails smoothly from your app. Set up email functions such as password resets, order confirmations and more.
-keywords: email, overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-### Introduction
-
-Payload comes ready to send your application's email. Whether you simply need built-in password reset
-email to work or you want customers to get an order confirmation email, you're almost there. Payload makes use of
-[NodeMailer](https://nodemailer.com) for email and won't get in your way for those already familiar.
-
-For email to send from your Payload server, some configuration is required. The settings you provide will be set
-in the `email` property object of your payload init call. Payload will make use of the transport that you have configured for it for things like reset password or verifying new user accounts and email send methods are available to you as well on your payload instance.
-
-### Configuration
-
-**Three ways to set it up**
-
-1. **Default**: When email is not needed, a mock email handler will be created and used when nothing is provided. This is ideal for development environments and can be changed later when ready to [go to production](/docs/production/deployment).
-1. **Recommended**: Set the `transportOptions` and Payload will do the set up for you.
-1. **Advanced**: The `transport` object can be assigned a nodemailer transport object set up in your server scripts and given for Payload to use.
-
-The following options are configurable in the `email` property object as part of the options object when calling payload.init().
-
-| Option                   | Description                                                                                                                                                                                  |
-| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`fromName`** \*        | The name part of the From field that will be seen on the delivered email                                                                                                                     |
-| **`fromAddress`** \*     | The email address part of the From field that will be used when delivering email                                                                                                             |
-| **`transport`**          | The NodeMailer transport object for when you want to do it yourself, not needed when transportOptions is set                                                                                 |
-| **`transportOptions`**   | An object that configures the transporter that Payload will create. For all the available options see the [NodeMailer documentation](https://nodemailer.com) or see the examples below |
-| **`logMockCredentials`** | If set to true and no transport/transportOptions, ethereal credentials will be logged to console on startup                                                                                  |
-
-_\* An asterisk denotes that a property is required._
-
-### Use SMTP
-
-Simple Mail Transfer Protocol (SMTP) options can be passed in using the `transportOptions` object on the `email` options. See the [NodeMailer SMTP documentation](https://nodemailer.com/smtp/) for more information, including details on when `secure` should and should not be set to `true`.
-
-**Example email options using SMTP:**
-
-```ts
-payload.init({
-  email: {
-    transportOptions: {
-      host: process.env.SMTP_HOST,
-      auth: {
-        user: process.env.SMTP_USER,
-        pass: process.env.SMTP_PASS,
-      },
-      port: Number(process.env.SMTP_HOST),
-      secure: Number(process.env.SMTP_PORT) === 465, // true for port 465, false (the default) for 587 and others
-      requireTLS: true,
-    },
-    fromName: 'hello',
-    fromAddress: 'hello@example.com',
-  },
-  // ...
-})
-```
-
-<Banner type="warning">
-  It is best practice to avoid saving credentials or API keys directly in your code, use
-  [environment variables](/docs/configuration/overview#using-environment-variables-in-your-config).
-</Banner>
-
-### Use an email service
-
-Many third party mail providers are available and offer benefits beyond basic SMTP. As an example, your payload init could look like this if you wanted to use SendGrid.com, though the same approach would work for any other [NodeMailer transports](https://nodemailer.com/transports/) shown here or provided by another third party.
-
-```ts
-import payload from 'payload'
-import nodemailerSendgrid from 'nodemailer-sendgrid'
-
-const sendGridAPIKey = process.env.SENDGRID_API_KEY
-
-payload.init({
-  ...(sendGridAPIKey
-    ? {
-        email: {
-          transportOptions: nodemailerSendgrid({
-            apiKey: sendGridAPIKey,
-          }),
-          fromName: 'Admin',
-          fromAddress: 'admin@example.com',
-        },
-      }
-    : {}),
-})
-```
-
-### Use a custom NodeMailer transport
-
-To take full control of the mail transport you may wish to use `nodemailer.createTransport()` on your server and provide it to Payload init.
-
-```ts
-import payload from 'payload'
-import nodemailer from 'nodemailer'
-
-const payload = require('payload')
-const nodemailer = require('nodemailer')
-
-const transport = await nodemailer.createTransport({
-  host: process.env.SMTP_HOST,
-  port: 587,
-  auth: {
-    user: process.env.SMTP_USER,
-    pass: process.env.SMTP_PASS,
-  },
-})
-
-payload.init({
-  email: {
-    fromName: 'Admin',
-    fromAddress: 'admin@example.com',
-    transport,
-  },
-  // ...
-})
-```
-
-### Sending Mail
-
-With a working transport you can call it anywhere you have access to payload by calling `payload.sendEmail(message)`. The `message` will contain the `to`, `subject` and `email` or `text` for the email being sent. To see all available message configuration options see [NodeMailer](https://nodemailer.com/message).
-
-### Mock transport
-
-By default, Payload uses a mock implementation that only sends mail to the [ethereal](https://ethereal.email) capture service that will never reach a user's inbox. While in development you may wish to make use of the captured messages which is why the payload output during server output helpfully logs this out on the server console.
-
-To see ethereal credentials, add `logMockCredentials: true` to the email options. This will cause them to be logged to console on startup.
-
-```ts
-payload.init({
-  email: {
-    fromName: 'Admin',
-    fromAddress: 'admin@example.com',
-    logMockCredentials: true, // Optional
-  },
-  // ...
-})
-```
-
-**Console output when starting payload with a mock email instance and logMockCredentials: true**
-
-```
-[06:37:21] INFO  (payload): Starting Payload...
-[06:37:22] INFO  (payload): Payload Demo Initialized
-[06:37:22] INFO  (payload): listening on 3000...
-[06:37:22] INFO  (payload): Connected to MongoDB server successfully!
-[06:37:23] INFO  (payload): E-mail configured with mock configuration
-[06:37:23] INFO  (payload): Log into mock email provider at https://ethereal.email
-[06:37:23] INFO  (payload): Mock email account username: hhav5jw7doo4euev@ethereal.email
-[06:37:23] INFO  (payload): Mock email account password: VNdGcvDZeyEhtuPBqf
-```
-
-The mock email handler is used when payload is started with neither `transport` or `transportOptions` to know how to deliver email.
-
-<Banner type="warning">
-  The randomly generated email account username and password will be different each time the Payload
-  server starts.
-</Banner>
-
-### Using multiple mail providers
-
-Payload supports the use of a single transporter of email, but there is nothing stopping you from having more. Consider a use case where sending bulk email is handled differently than transactional email and could be done using a [hook](/docs/hooks/overview).

docs/examples/overview.mdx

@@ -1,39 +0,0 @@
----
-title: Examples
-label: Overview
-order: 10
-desc:
-keywords: example, examples, starter, boilerplate, template, templates
----
-
-Payload provides a vast array of examples to help you get started with your project no matter what you are working on. These examples are designed to be easy to get up and running, and to be easy to understand. They showcase nothing more than the specific features being demonstrated, so you can easily decipher what is going on.
-
-Examples are changing every day, so be sure to check back often to see what new examples have been added. If you have a specific example you would like to see, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.
-
-- [Auth](https://github.com/payloadcms/payload/tree/main/examples/auth)
-- [Custom Server](https://github.com/payloadcms/payload/tree/main/examples/custom-server)
-- [Draft Preview](https://github.com/payloadcms/payload/tree/main/examples/draft-preview)
-- [Email](https://github.com/payloadcms/payload/tree/main/examples/email)
-- [Form Builder](https://github.com/payloadcms/payload/tree/main/examples/form-builder)
-- [Hierarchy](https://github.com/payloadcms/payload/tree/main/examples/hierarchy)
-- [Live Preview](https://github.com/payloadcms/payload/tree/main/examples/live-preview)
-- [Multi-tenant](https://github.com/payloadcms/payload/tree/main/examples/multi-tenant)
-- [Nested Docs](https://github.com/payloadcms/payload/tree/main/examples/nested-docs)
-- [Redirects](https://github.com/payloadcms/payload/tree/main/examples/redirects)
-- [Tests](https://github.com/payloadcms/payload/tree/main/examples/testing)
-- [Virtual Fields](https://github.com/payloadcms/payload/tree/main/examples/virtual-fields)
-- [White-label Admin UI](https://github.com/payloadcms/payload/tree/main/examples/whitelabel)
-
-Where necessary, some examples include a front-end. Examples that require a front-end share this folder structure:
-
-```plaintext
-example/
-├── payload/
-├── next-app/
-├── next-pages/
-├── react-router/
-├── vue/
-├── svelte/
-```
-
-Where `payload` is your Payload project, and the other directories are dedicated to their respective front-end framework. We are adding new examples every day, so if your framework of choice is not yet supported in any particular example, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.

docs/fields/array.mdx

@@ -1,114 +0,0 @@
----
-title: Array Field
-label: Array
-order: 20
-desc: Array fields are intended for sets of repeating fields, that you define. Learn how to use array fields, see examples and options.
-keywords: array, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Array field type is used when you need to have a set of "repeating" fields. It stores an array
-  of objects containing the fields that you define. Its uses can be simple or highly complex.
-</Banner>
-
-<LightDarkImage
-srcLight="https://payloadcms.com/images/docs/fields/array.png"
-srcDark="https://payloadcms.com/images/docs/fields/array-dark.png"
-alt="Array field with two Rows in Payload admin panel"
-caption="Admin panel screenshot of an Array field with two Rows"
-/>
-
-**Example uses:**
-
-- A "slider" with an image ([upload field](/docs/fields/upload)) and a caption ([text field](/docs/fields/text))
-- Navigational structures where editors can specify nav items containing
-  pages ([relationship field](/docs/fields/relationship)), an "open in new tab" [checkbox field](/docs/fields/checkbox)
-- Event agenda "timeslots" where you need to specify start & end time ([date field](/docs/fields/date)),
-  label ([text field](/docs/fields/text)), and Learn More page [relationship](/docs/fields/relationship)
-
-### Config
-
-| Option              | Description                                                                                                                                                                                                                                                                        |
-|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
-| **`label`**         | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
-| **`fields`** \*     | Array of field types to correspond to each row of the Array.                                                                                                                                                                                                                       |
-| **`validate`**      | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
-| **`minRows`**       | A number for the fewest allowed items during validation when a value is present.                                                                                                                                                                                                   |
-| **`maxRows`**       | A number for the most allowed items during validation when a value is present.                                                                                                                                                                                                     |
-| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                                                                                      |
-| **`hooks`**         | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                                                                                         |
-| **`access`**        | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                                                                                            |
-| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                                                                                                   |
-| **`defaultValue`**  | Provide an array of row data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                               |
-| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Array will be kept, so there is no need to specify each nested field as `localized`. |
-| **`required`**      | Require this field to have a value.                                                                                                                                                                                                                                                |
-| **`labels`**        | Customize the row labels appearing in the Admin dashboard.                                                                                                                                                                                                                         |
-| **`admin`**         | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                                                                                          |
-| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
-| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas).                                                                                                |
-| **`dbName`**        | Custom table name for the field when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined.                                                                                                                                    |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin Config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following
-properties:
-
-| Option                    | Description                                                                                                          |
-|---------------------------|----------------------------------------------------------------------------------------------------------------------|
-| **`initCollapsed`**       | Set the initial collapsed state                                                                                      |
-| **`isSortable`**          | Disable array order sorting by setting this value to `false`                                                               |
-| **`components.RowLabel`** | Function or React component to be rendered as the label on the array row. Receives `({ data, index, path })` as args |
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-import { RowLabelArgs } from 'payload/dist/admin/components/forms/RowLabel/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'slider', // required
-      type: 'array', // required
-      label: 'Image Slider',
-      minRows: 2,
-      maxRows: 10,
-      interfaceName: 'CardSlider', // optional
-      labels: {
-        singular: 'Slide',
-        plural: 'Slides',
-      },
-      fields: [
-        // required
-        {
-          name: 'title',
-          type: 'text',
-        },
-        {
-          name: 'image',
-          type: 'upload',
-          relationTo: 'media',
-          required: true,
-        },
-        {
-          name: 'caption',
-          type: 'text',
-        },
-      ],
-      admin: {
-        components: {
-          RowLabel: ({ data, index }: RowLabelArgs) => {
-            return data?.title || `Slide ${String(index).padStart(2, '0')}`
-          },
-        },
-      },
-    },
-  ],
-}
-```

docs/fields/blocks.mdx

@@ -1,152 +0,0 @@
----
-title: Blocks Field
-label: Blocks
-order: 30
-desc: The Blocks field type is a great layout build and can be used to construct any flexible content model. Learn how to use Block fields, see examples and options.
-keywords: blocks, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Blocks field type is <strong>incredibly powerful</strong> and can be used as a{' '}
-  <em>layout builder</em> as well as to define any other flexible content model you can think of. It
-  stores an array of objects, where each object must match the shape of one of your provided block
-  configs.
-</Banner>
-
-<LightDarkImage
-srcLight="https://payloadcms.com/images/docs/fields/blocks.png"
-srcDark="https://payloadcms.com/images/docs/fields/blocks-dark.png"
-alt="Admin panel screenshot of add Blocks drawer view"
-caption="Admin panel screenshot of add Blocks drawer view"
-/>
-
-**Example uses:**
-
-- A layout builder tool that grants editors to design highly customizable page or post layouts. Blocks could include
-  configs such as `Quote`, `CallToAction`, `Slider`, `Content`, `Gallery`, or others.
-- A form builder tool where available block configs might be `Text`, `Select`, or `Checkbox`.
-- Virtual event agenda "timeslots" where a timeslot could either be a `Break`, a `Presentation`, or a `BreakoutSession`.
-
-### Field config
-
-| Option             | Description                                                                                                                                                                                                                                                                        |
-|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
-| **`label`**        | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
-| **`blocks`** \*    | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field.                                                                                                                                                                                    |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
-| **`minRows`**      | A number for the fewest allowed items during validation when a value is present.                                                                                                                                                                                                   |
-| **`maxRows`**      | A number for the most allowed items during validation when a value is present.                                                                                                                                                                                                     |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                                                                                      |
-| **`hooks`**        | Provide field-level hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                                                                                         |
-| **`access`**       | Provide field-level access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                                                                                            |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin panel.                                                                                                                          |
-| **`defaultValue`** | Provide an array of block data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                             |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                                                                                                       |
-| **`labels`**       | Customize the block row labels appearing in the Admin dashboard.                                                                                                                                                                                                                   |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                                                                                          |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin Config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following
-properties:
-
-| Option              | Description                     |
-|---------------------|---------------------------------|
-| **`initCollapsed`** | Set the initial collapsed state |
-| **`isSortable`** | Disable block order sorting by setting this value to `false` |
-
-### Block configs
-
-Blocks are defined as separate configs of their own.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  Best practice is to define each block config in its own file, and then import them into your
-  Blocks field as necessary. This way each block config can be easily shared between fields. For
-  instance, using the "layout builder" example, you might want to feature a few of the same blocks
-  in a Post collection as well as a Page collection. Abstracting into their own files trivializes
-  their reusability.
-</Banner>
-
-| Option                     | Description                                                                                                                                                                         |
-|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`slug`** \*              | Identifier for this block type. Will be saved on each block as the `blockType` property.                                                                                            |
-| **`fields`** \*            | Array of fields to be stored in this block.                                                                                                                                         |
-| **`labels`**               | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined.                                                                             |
-| **`imageURL`**             | Provide a custom image thumbnail to help editors identify this block in the Admin UI.                                                                                               |
-| **`imageAltText`**         | Customize this block's image thumbnail alt text.                                                                                                                                    |
-| **`interfaceName`**        | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
-| **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined. NOTE: this is set for deprecation, prefer `interfaceName`.                                        |
-| **`dbName`**               | Custom table name for this block type when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from slug if not defined.
-| **`custom`**               | Extension point for adding custom data (e.g. for plugins)                                                                                                                           |
-
-#### Auto-generated data per block
-
-In addition to the field data that you define on each block, Payload will store two additional properties on each block:
-
-**`blockType`**
-
-The `blockType` is saved as the slug of the block that has been selected.
-
-**`blockName`**
-
-The Admin panel provides each block with a `blockName` field which optionally allows editors to label their blocks for
-better editability and readability.
-
-### Example
-
-`collections/ExampleCollection.js`
-
-```ts
-import { Block, CollectionConfig } from 'payload/types'
-
-const QuoteBlock: Block = {
-  slug: 'Quote', // required
-  imageURL: 'https://google.com/path/to/image.jpg',
-  imageAltText: 'A nice thumbnail image to show what this block looks like',
-  interfaceName: 'QuoteBlock', // optional
-  fields: [
-    // required
-    {
-      name: 'quoteHeader',
-      type: 'text',
-      required: true,
-    },
-    {
-      name: 'quoteText',
-      type: 'text',
-    },
-  ],
-}
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'layout', // required
-      type: 'blocks', // required
-      minRows: 1,
-      maxRows: 20,
-      blocks: [
-        // required
-        QuoteBlock,
-      ],
-    },
-  ],
-}
-```
-
-### TypeScript
-
-As you build your own Block configs, you might want to store them in separate files but retain typing accordingly. To do
-so, you can import and use Payload's `Block` type:
-
-```ts
-import type { Block } from 'payload/types'
-```

docs/fields/checkbox.mdx

@@ -1,56 +0,0 @@
----
-title: Checkbox Field
-label: Checkbox
-order: 40
-desc: Checkbox field types allow the developer to save a boolean value in the database. Learn how to use Checkbox fields, see examples and options.
-keywords: checkbox, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>The Checkbox field type saves a boolean in the database.</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/checkbox.png"
-  srcDark="https://payloadcms.com/images/docs/fields/checkbox-dark.png"
-  alt="Checkbox field with text field in Payload admin panel"
-  caption="Admin panel screenshot of Checkbox field with Text field below"
-/>
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value, will default to false if field is also `required`. [More](/docs/fields/overview#default-values)                                             |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                                            |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'enableCoolStuff', // required
-      type: 'checkbox', // required
-      label: 'Click me to see fanciness',
-      defaultValue: false,
-    },
-  ],
-}
-```

docs/fields/code.mdx

@@ -1,76 +0,0 @@
----
-title: Code Field
-label: Code
-order: 50
-desc: The Code field type will store any string in the Database. Learn how to use Code fields, see examples and options.
-
-keywords: code, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Code field type saves a string in the database, but provides the Admin panel with a code
-  editor styled interface.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/code.png"
-  srcDark="https://payloadcms.com/images/docs/fields/code-dark.png"
-  alt="Shows a Code field in the Payload admin panel"
-  caption="Admin panel screenshot of a Code field"
-/>
-
-This field uses the `monaco-react` editor syntax highlighting.
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`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.                                                                                                                        |
-| **`index`**        | Build an [index](/docs/database#overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                                         |
-| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                                         |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin Config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
-
-| Option              | Description                                                                                                                                                                     |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`language`**      | This property can be set to any language listed [here](https://github.com/microsoft/monaco-editor/tree/main/src/basic-languages).                                               |
-| **`editorOptions`** | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IDiffEditorConstructionOptions.html). |
-
-### Example
-
-`collections/ExampleCollection.ts
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'trackingCode', // required
-      type: 'code', // required
-      required: true,
-      admin: {
-        language: 'javascript',
-      },
-    },
-  ],
-}
-```

docs/fields/collapsible.mdx

@@ -1,69 +0,0 @@
----
-title: Collapsible Field
-label: Collapsible
-order: 60
-desc: With the Collapsible field, you can place fields within a collapsible layout component that can be collapsed / expanded.
-keywords: row, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Collapsible field is presentational-only and only affects the Admin panel. By using it, you
-  can place fields within a nice layout component that can be collapsed / expanded.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/collapsible.png"
-  srcDark="https://payloadcms.com/images/docs/fields/collapsible-dark.png"
-  alt="Shows a Collapsible field in the Payload admin panel"
-  caption="Admin panel screenshot of a Collapsible field"
-/>
-
-### Config
-
-| Option          | Description                                                                                                                                                                  |
-| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`label`** \*  | A label to render within the header of the collapsible component. This can be a string, function or react component. Function/components receive `({ data, path })` as args. |
-| **`fields`** \* | Array of field types to nest within this Collapsible.                                                                                                                        |
-| **`admin`**     | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                    |
-| **`custom`**    | Extension point for adding custom data (e.g. for plugins)                                                                                                                    |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin Config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
-
-| Option              | Description                     |
-| ------------------- | ------------------------------- |
-| **`initCollapsed`** | Set the initial collapsed state |
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      label: ({ data }) => data?.title || 'Untitled',
-      type: 'collapsible', // required
-      fields: [
-        // required
-        {
-          name: 'title',
-          type: 'text',
-          required: true,
-        },
-        {
-          name: 'someTextField',
-          type: 'text',
-          required: true,
-        },
-      ],
-    },
-  ],
-}
-```

docs/fields/date.mdx

@@ -1,116 +0,0 @@
----
-title: Date Field
-label: Date
-order: 70
-desc: The Date field type stores a Date in the database. Learn how to use and customize the Date field, see examples and options.
-keywords: date, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Date field type saves a Date in the database and provides the Admin panel with a customizable
-  time picker interface.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/date.png"
-  srcDark="https://payloadcms.com/images/docs/fields/date-dark.png"
-  alt="Shows a Date field in the Payload admin panel"
-  caption="Admin panel screenshot of a Date field"
-/>
-
-This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepicker) for the Admin panel component.
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin Config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can customize the following fields that will adjust how the component displays in the admin panel via the `date` property.
-
-| Property                       | Description                                                                                 |
-| ------------------------------ | ------------------------------------------------------------------------------------------- |
-| **`placeholder`**              | Placeholder text for the field.                                                             |
-| **`date`**                     | Pass options to customize date field appearance.                                            |
-| **`date.displayFormat`**       | Format date to be shown in field **cell**.                                                  |
-| **`date.pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. |
-| **`date.monthsToShow`** \*     | Number of months to display max is 2. Defaults to 1.                                        |
-| **`date.minDate`** \*          | Min date value to allow.                                                                    |
-| **`date.maxDate`** \*          | Max date value to allow.                                                                    |
-| **`date.minTime`** \*          | Min time value to allow.                                                                    |
-| **`date.maxTime`** \*          | Max date value to allow.                                                                    |
-| **`date.overrides`** \*        | Pass any valid props directly to the [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md)     |
-| **`date.timeIntervals`** \*    | Time intervals to display. Defaults to 30 minutes.                                          |
-| **`date.timeFormat`** \*       | Determines time format. Defaults to `'h:mm aa'`.                                            |
-
-_\* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._
-
-#### Display Format and Picker Appearance
-
-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].
-
-`pickerAppearance` sets the appearance of the **react datepicker**, the options available are `dayAndTime`, `dayOnly`, `timeOnly`, and `monthOnly`. By default, the datepicker will display `dayOnly`.
-
-When only `pickerAppearance` is set, an equivalent format will be rendered in the date field cell. To overwrite this format, set `displayFormat`.
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'dateOnly',
-      type: 'date',
-      admin: {
-        date: {
-          pickerAppearance: 'dayOnly',
-          displayFormat: 'd MMM yyy',
-        },
-      },
-    },
-    {
-      name: 'timeOnly',
-      type: 'date',
-      admin: {
-        date: {
-          pickerAppearance: 'timeOnly',
-          displayFormat: 'h:mm:ss a',
-        },
-      },
-    },
-    {
-      name: 'monthOnly',
-      type: 'date',
-      admin: {
-        date: {
-          pickerAppearance: 'monthOnly',
-          displayFormat: 'MMMM yyyy',
-        },
-      },
-    },
-  ],
-}
-```

docs/fields/email.mdx

@@ -1,69 +0,0 @@
----
-title: Email Field
-label: Email
-order: 80
-desc: The Email field enforces that the value provided is a valid email address. Learn how to use Email fields, see examples and options.
-keywords: email, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>The Email field enforces that the value provided is a valid email address.</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/email.png"
-  srcDark="https://payloadcms.com/images/docs/fields/email-dark.png"
-  alt="Shows an Email field in the Payload admin panel"
-  caption="Admin panel screenshot of an Email field"
-/>
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`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.                                                                                                                        |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), this field type allows for the following `admin` properties:
-
-**`placeholder`**
-
-Set this property to define a placeholder string for the field.
-
-**`autoComplete`**
-
-Set this property to a string that will be used for browser autocomplete.
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'contact', // required
-      type: 'email', // required
-      label: 'Contact Email Address',
-      required: true,
-    },
-  ],
-}
-```

docs/fields/group.mdx

@@ -1,83 +0,0 @@
----
-title: Group Field
-label: Group
-order: 90
-desc: The Group field allows other fields to be nested under a common property. Learn how to use Group fields, see examples and options.
-keywords: group, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Group field allows fields to be nested under a common property name. It also groups fields
-  together visually in the Admin panel.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/group.png"
-  srcDark="https://payloadcms.com/images/docs/fields/group-dark.png"
-  alt="Shows a Group field in the Payload admin panel"
-  caption="Admin panel screenshot of a Group field"
-/>
-
-### Config
-
-| Option              | Description                                                                                                                                                                                                                                                                        |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
-| **`fields`** \*     | Array of field types to nest within this Group.                                                                                                                                                                                                                                    |
-| **`label`**         | Used as a heading in the Admin panel and to name the generated GraphQL type.                                                                                                                                                                                                       |
-| **`validate`**      | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
-| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                                                                                      |
-| **`hooks`**         | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                                                                                         |
-| **`access`**        | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                                                                                            |
-| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                                                                                                   |
-| **`defaultValue`**  | Provide an object of data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                                  |
-| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Group will be kept, so there is no need to specify each nested field as `localized`. |
-| **`admin`**         | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                                                                                          |
-| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
-| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas).                                                                                                |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Group allows for the following admin property:
-
-**`hideGutter`**
-
-Set this property to `true` to hide this field's gutter within the admin panel. The field gutter is rendered as a vertical line and padding, but often if this field is nested within a Group, Block, or Array, you may want to hide the gutter.
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'pageMeta', // required
-      type: 'group', // required
-      interfaceName: 'Meta', // optional
-      fields: [
-        // required
-        {
-          name: 'title',
-          type: 'text',
-          required: true,
-          minLength: 20,
-          maxLength: 100,
-        },
-        {
-          name: 'description',
-          type: 'textarea',
-          required: true,
-          minLength: 40,
-          maxLength: 160,
-        },
-      ],
-    },
-  ],
-}
-```

docs/fields/json.mdx

@@ -1,136 +0,0 @@
----
-title: JSON Field
-label: JSON
-order: 50
-desc: The JSON field type will store any string in the Database. Learn how to use JSON fields, see examples and options.
-
-keywords: json, jsonSchema, schema, validation, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The JSON field type saves actual JSON in the database, which differs from the Code field that
-  saves the value as a string in the database.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/json.png"
-  srcDark="https://payloadcms.com/images/docs/fields/json-dark.png"
-  alt="Shows a JSON field in the Payload admin panel"
-  caption="Admin panel screenshot of a JSON field"
-/>
-
-This field uses the `monaco-react` editor syntax highlighting.
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`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.                                                                                                                        |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`jsonSchema`**   | Provide a JSON schema that will be used for validation. [JSON schemas](https://json-schema.org/learn/getting-started-step-by-step)                                                                  |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin Config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
-
-| Option              | Description                                                                                                                                                                        |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`editorOptions`** | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/typedoc/variables/editor.EditorOptions.html). |
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'customerJSON', // required
-      type: 'json', // required
-      required: true,
-    },
-  ],
-}
-```
-
-### JSON Schema Validation
-
-Payload JSON fields fully support the [JSON schema](https://json-schema.org/) standard. By providing a schema in your field config, the editor will be guided in the admin UI, getting typeahead for properties and their formats automatically. When the document is saved, the default validation will prevent saving any invalid data in the field according to the schema in your config.
-
-If you only provide a URL to a schema, Payload will fetch the desired schema if it is publicly available. If not, it is recommended to add the schema directly to your config or import it from another file so that it can be implemented consistently in your project.
-
-
-#### Local JSON Schema
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'customerJSON', // required
-      type: 'json', // required
-      jsonSchema: {
-        uri: 'a://b/foo.json', // required
-        fileMatch: ['a://b/foo.json'], // required
-        schema: {
-          type: 'object',
-          properties: {
-            foo: {
-              enum: ['bar', 'foobar'],
-            }
-          },
-        },
-      },
-
-    },
-  ],
-}
-// {"foo": "bar"} or {"foo": "foobar"} - ok
-// Attempting to create {"foo": "not-bar"} will throw an error
-```
-
-#### Remote JSON Schema
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'customerJSON', // required
-      type: 'json', // required
-      jsonSchema: {
-        uri: 'https://example.com/customer.schema.json', // required
-        fileMatch: ['https://example.com/customer.schema.json'], // required
-      },
-    },
-  ],
-}
-// If 'https://example.com/customer.schema.json' has a JSON schema
-// {"foo": "bar"} or {"foo": "foobar"} - ok
-// Attempting to create {"foo": "not-bar"} will throw an error
-```

docs/fields/number.mdx

@@ -1,83 +0,0 @@
----
-title: Number Field
-label: Number
-order: 100
-desc: Number fields store and validate numeric data. Learn how to use and format Number fields, see examples and Number field options.
-keywords: number, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Number field stores and validates numeric entry and supports additional numerical validation
-  and formatting features.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/number.png"
-  srcDark="https://payloadcms.com/images/docs/fields/number-dark.png"
-  alt="Shows a Number field in the Payload admin panel"
-  caption="Admin panel screenshot of a Number field"
-/>
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
-| **`min`**          | Minimum value accepted. Used in the default `validation` function.                                                                                                                                  |
-| **`max`**          | Maximum value accepted. Used in the default `validation` function.                                                                                                                                  |
-| **`hasMany`**      | Makes this field an ordered array of numbers instead of just a single number.                                                                                                                       |
-| **`minRows`**      | Minimum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                                        |
-| **`maxRows`**      | Maximum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                                        |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), this field type allows for the following `admin` properties:
-
-**`step`**
-
-Set a value for the number field to increment / decrement using browser controls.
-
-**`placeholder`**
-
-Set this property to define a placeholder string for the field.
-
-**`autoComplete`**
-
-Set this property to a string that will be used for browser autocomplete.
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'age', // required
-      type: 'number', // required
-      required: true,
-      admin: {
-        step: 1,
-      },
-    },
-  ],
-}
-```

docs/fields/overview.mdx

@@ -1,323 +0,0 @@
----
-title: Fields Overview
-label: Overview
-order: 10
-desc: Fields are the building blocks of Payload, find out how to add or remove a field, change field type, add hooks, define access control and validation.
-keywords: overview, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner type="info">
-  Fields are the building blocks of Payload. Collections and Globals both use Fields to define the
-  shape of the data that they store. Payload offers a wide variety of field types - both simple and
-  complex.
-</Banner>
-
-Fields are defined as an array on Collections and Globals via the `fields` key. They define the shape of the data that will be stored as well as automatically construct the corresponding Admin UI.
-
-The required `type` property on a field determines what values it can accept, how it is presented in the API, and how the field will be rendered in the admin interface.
-
-**Simple collection with two fields:**
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Page: CollectionConfig = {
-  slug: 'pages',
-  fields: [
-    {
-      name: 'myField',
-      type: 'text', // highlight-line
-    },
-    {
-      name: 'otherField',
-      type: 'checkbox', // highlight-line
-    },
-  ],
-}
-```
-
-### Field types
-
-- [Array](/docs/fields/array) - for repeating content, supports nested fields
-- [Blocks](/docs/fields/blocks) - block-based fields, allowing powerful layout creation
-- [Checkbox](/docs/fields/checkbox) - boolean true / false checkbox
-- [Code](/docs/fields/code) - code editor that saves a string to the database
-- [Collapsible](/docs/fields/collapsible) - used for admin layout, nest fields within a collapsible component
-- [Date](/docs/fields/date) - date / time field that saves a timestamp
-- [Email](/docs/fields/email) - validates the entry is a properly formatted email
-- [Group](/docs/fields/group) - nest fields within an object
-- [JSON](/docs/fields/json) - saves actual JSON in the database
-- [Number](/docs/fields/number) - field that enforces that its value be a number
-- [Point](/docs/fields/point) - geometric coordinates for location data
-- [Radio](/docs/fields/radio) - radio button group, allowing only one value to be selected
-- [Relationship](/docs/fields/relationship) - assign relationships to other collections
-- [Rich Text](/docs/fields/rich-text) - fully extensible Rich Text editor
-- [Row](/docs/fields/row) - used for admin field layout, no effect on data shape
-- [Select](/docs/fields/select) - dropdown / picklist style value selector
-- [Tabs](/docs/fields/tabs) - used for admin layout, nest fields within tabs
-- [Text](/docs/fields/text) - simple text input
-- [Textarea](/docs/fields/textarea) - allows a bit larger of a text editor
-- [Upload](/docs/fields/upload) - allows local file and image upload
-- [UI](/docs/fields/ui) - inject your own custom components and do whatever you need
-
-### Field-level hooks
-
-One of the most powerful parts about Payload is its ability for you to define field-level hooks that can control the logic of your fields to a fine-grained level. for more information about how to define field hooks, [click here](/docs/hooks/overview#field-hooks).
-
-### Field-level access control
-
-In addition to being able to define access control on a document-level, you can define extremely granular permissions on a field by field level. For more information about field-level access control, [click here](/docs/access-control/overview#fields).
-
-### Field names
-
-Some fields use their `name` property as a unique identifier to store and retrieve from the database. `__v`, `salt`, and `hash` are all reserved field names which are sanitized from Payload's config and cannot be used.
-
-### Validation
-
-Field validation is enforced automatically based on the field type and other properties such as `required` or `min` and `max` value constraints on certain field types. This default behavior can be replaced by providing your own validate function for any field. It will be used on both the frontend and the backend, so it should not rely on any Node-specific packages. The validation function can be either synchronous or asynchronous and expects to return either `true` or a string error message to display in both API responses and within the Admin panel.
-
-There are two arguments available to custom validation functions.
-
-1. The value which is currently assigned to the field
-2. An optional object with dynamic properties for more complex validation having the following:
-
-| Property      | Description                                                                                                              |
-| ------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `data`        | An object of the full collection or global document.                                                                     |
-| `siblingData` | An object of the document data limited to fields within the same parent to the field.                                    |
-| `operation`   | Will be "create" or "update" depending on the UI action or API call.                                                     |
-| `id`          | The value of the collection `id`, will be `undefined` on create request.                                                 |
-| `t`           | The function for translating text, [more](/docs/configuration/i18n).                                                     |
-| `user`        | The currently authenticated user object.                                                                                 |
-| `payload`     | If the `validate` function is being executed on the server, Payload will be exposed for easily running local operations. |
-
-Example:
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const Orders: CollectionConfig = {
-  slug: 'orders',
-  fields: [
-    {
-      name: 'customerNumber',
-      type: 'text',
-      validate: async (val, { operation }) => {
-        if (operation !== 'create') {
-          // skip validation on update
-          return true
-        }
-        const response = await fetch(`https://your-api.com/customers/${val}`)
-        if (response.ok) {
-          return true
-        }
-
-        return 'The customer number provided does not match any customers within our records.'
-      },
-    },
-  ],
-}
-```
-
-When supplying a field `validate` function, Payload will use yours in place of the default. To make use of the default field validation in your custom logic you can import, call and return the result as needed.
-
-For example:
-
-```ts
-import { text } from 'payload/fields/validations'
-
-const field: Field = {
-  name: 'notBad',
-  type: 'text',
-  validate: (val, args) => {
-    if (val === 'bad') {
-      return 'This cannot be "bad"'
-    }
-    // highlight-start
-    return text(val, args)
-    // highlight-end
-  },
-}
-```
-
-### Customizable ID
-
-Collections ID fields are generated automatically by default. An explicit `id` field can be declared in the `fields` array to override this behavior.
-Users are then required to provide a custom ID value when creating a record through the Admin UI or API.
-Valid ID types are `number` and `text`.
-
-Example:
-
-```ts
-{
-  fields: [
-    {
-      name: 'id',
-      type: 'number',
-    },
-  ],
-}
-```
-
-### Admin config
-
-In addition to each field's base configuration, you can define specific traits and properties for fields that only have effect on how they are rendered in the Admin panel. The following properties are available for all fields within the `admin` property:
-
-| Option              | Description                                                                                                                                                                                                                      |
-| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `condition`         | You can programmatically show / hide fields based on what other fields are doing. [Click here](#conditional-logic) for more info.                                                                                                |
-| `components`        | All field components can be completely and easily swapped out for custom components that you define. [Click here](#custom-components) for more info.                                                                             |
-| `description`       | Helper text to display with the field to provide more information for the editor user. [Click here](#description) for more info.                                                                                                 |
-| `position`          | Specify if the field should be rendered in the sidebar by defining `position: 'sidebar'`.                                                                                                                                        |
-| `width`             | Restrict the width of a field. you can pass any string-based value here, be it pixels, percentages, etc. This property is especially useful when fields are nested within a `Row` type where they can be organized horizontally. |
-| `style`             | Attach raw CSS style properties to the root DOM element of a field.                                                                                                                                                              |
-| `className`         | Attach a CSS class name to the root DOM element of a field.                                                                                                                                                                      |
-| `readOnly`          | Setting a field to `readOnly` has no effect on the API whatsoever but disables the admin component's editability to prevent editors from modifying the field's value.                                                            |
-| `disabled`          | If a field is `disabled`, it is completely omitted from the Admin panel.                                                                                                                                                         |
-| `disableBulkEdit`   | Set `disableBulkEdit` to `true` to prevent fields from appearing in the select options when making edits for multiple documents.                                                                                                 |
-| `disableListColumn` | Set `disableListColumn` to `true` to prevent fields from appearing in the list view column selector.                                                                                                                             |
-| `disableListFilter` | Set `disableListFilter` to `true` to prevent fields from appearing in the list view filter options.                                                                                                                              |
-| `hidden`            | Setting a field's `hidden` property on its `admin` config will transform it into a `hidden` input type. Its value will still submit with the Admin panel's requests, but the field itself will not be visible to editors.        |
-
-### Custom components
-
-All Payload fields support the ability to swap in your own React components with ease. For more information, including examples, [click here](/docs/admin/components#fields).
-
-### 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:
-
-- `data` - the entire document's data that is currently being edited
-- `siblingData` - only the fields that are direct siblings to the field with the condition
-- `{ user }` - the final argument is an object containing the currently authenticated user
-
-The `condition` function should return a boolean that will control if the field should be displayed or not.
-
-**Example:**
-
-```ts
-{
-  fields: [
-    {
-      name: 'enableGreeting',
-      type: 'checkbox',
-      defaultValue: false,
-    },
-    {
-      name: 'greeting',
-      type: 'text',
-      admin: {
-        // highlight-start
-        condition: (data, siblingData, { user }) => {
-          if (data.enableGreeting) {
-            return true
-          } else {
-            return false
-          }
-        },
-        // highlight-end
-      },
-    },
-  ]
-}
-```
-
-### Default values
-
-Fields can be prefilled with starting values using the `defaultValue` property. This is used in the admin UI and also on the backend as API requests will be populated with missing or undefined field values. You can assign the defaultValue directly in the field configuration or supply a function for dynamic behavior. Values assigned during a create request on the server are added before validation occurs.
-
-Functions are called with an optional argument object containing:
-
-- `user` - the authenticated user object
-- `locale` - the currently selected locale string
-
-Here is an example of a defaultValue function that uses both:
-
-```ts
-const translation: {
-  en: 'Written by'
-  es: 'Escrito por'
-}
-
-const field = {
-  name: 'attribution',
-  type: 'text',
-  // highlight-start
-  defaultValue: ({ user, locale }) => `${translation[locale]} ${user.name}`,
-  // highlight-end
-}
-```
-
-<Banner type="success">
-  You can use async defaultValue functions to fill fields with data from API requests.
-</Banner>
-
-### Description
-
-A description can be configured in three ways.
-
-- As a string
-- As a function which returns a string
-- As a React component
-
-Functions are called with an optional argument object with the following shape, and React components are rendered with the following props:
-
-- `path` - the path of the field
-- `value` - the current value of the field
-
-As shown above, you can simply provide a string that will show by the field, but there are use cases where you may want to create some dynamic feedback. By using a function or a component for the `description` property you can provide realtime feedback as the user interacts with the form.
-
-**Function Example:**
-
-```ts
-{
-  fields: [
-    {
-      name: 'message',
-      type: 'text',
-      maxLength: 20,
-      admin: {
-        description: ({ path, value }) =>
-          `${typeof value === 'string' ? 20 - value.length : '20'} characters left (field: ${path})`,
-      },
-    },
-  ]
-}
-```
-
-This example will display the number of characters allowed as the user types.
-
-**Component Example:**
-
-```ts
-{
-  fields: [
-    {
-      name: 'message',
-      type: 'text',
-      maxLength: 20,
-      admin: {
-        description:
-          ({ path, value }) => (
-            <div>
-              Character count:
-              {' '}
-              { value?.length || 0 }
-               (field: {path})
-            </div>
-          )
-      }
-    }
-  ]
-}
-```
-
-This component will count the number of characters entered, as well as display the path of the field.
-
-### TypeScript
-
-You can import the internal Payload `Field` type as well as other common field types as follows:
-
-```ts
-import type { Field } from 'payload/types'
-```

docs/fields/point.mdx

@@ -1,74 +0,0 @@
----
-title: Point Field
-label: Point
-order: 110
-desc: The Point field type stores coordinates in the database. Learn how to use Point field for geolocation and geometry.
-
-keywords: point, geolocation, geospatial, geojson, 2dsphere, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Point field type saves a pair of coordinates in the database and assigns an index for location
-  related queries.
-</Banner>
-
-<Banner type="warning">
-  <strong>Note:</strong> The Point field type is currently only supported in MongoDB.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/point.png"
-  srcDark="https://payloadcms.com/images/docs/fields/point-dark.png"
-  alt="Shows a Point field in the Payload admin panel"
-  caption="Admin panel screenshot of a Point field"
-/>
-
-The data structure in the database matches the GeoJSON structure to represent point. The Payload APIs simplifies the object data to only the [longitude, latitude] location.
-
-### Config
-
-| Option             | Description                                                                                                                                                                                                       |
-| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                            |
-| **`label`**        | Used as a field label in the Admin panel and to name the generated GraphQL type.                                                                                                                                  |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                                      |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. To support location queries, point index defaults to `2dsphere`, to disable the index set to `false`. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                      |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                     |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                        |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                           |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                                  |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                              |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                                   |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                               |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                         |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                         |
-
-_\* An asterisk denotes that a property is required._
-
-<Banner type="warning">
-  <strong>Note:</strong> The Point field type is currently only supported in MongoDB.
-</Banner>
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'location',
-      type: 'point',
-      label: 'Location',
-    },
-  ],
-}
-```
-
-### Querying
-
-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.

docs/fields/radio.mdx

@@ -1,91 +0,0 @@
----
-title: Radio Group Field
-label: Radio Group
-order: 120
-desc: The Radio field type allows for the selection of one value from a predefined set of possible values. Learn how to use Radio fields, see examples and options.
-keywords: radio, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Radio Group field type allows for the selection of one value from a predefined set of possible
-  values and presents a radio group-style set of inputs to the Admin panel.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/radio.png"
-  srcDark="https://payloadcms.com/images/docs/fields/radio-dark.png"
-  alt="Shows a Radio field in the Payload admin panel"
-  caption="Admin panel screenshot of a Radio field"
-/>
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing an `label` string and a `value` string.                                          |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. The default value must exist within provided values in `options`. [More](/docs/fields/overview#default-values)                              |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-| **`enumName`**     | Custom enum name for this field when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined.
-
-_\* An asterisk denotes that a property is required._
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  Option values should be strings that do not contain hyphens or special characters due to GraphQL
-  enumeration naming constraints. Underscores are allowed. If you determine you need your option
-  values to be non-strings or contain special characters, they will be formatted accordingly before
-  being used as a GraphQL enum.
-</Banner>
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Radio Group field type allows for the specification of the following `admin` properties:
-
-**`layout`**
-
-The `layout` property allows for the radio group to be styled as a horizonally or vertically distributed list. The default value is `horizontal`.
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'color', // required
-      type: 'radio', // required
-      options: [
-        // required
-        {
-          label: 'Mint',
-          value: 'mint',
-        },
-        {
-          label: 'Dark Gray',
-          value: 'dark_gray',
-        },
-      ],
-      defaultValue: 'mint', // The first value in options.
-      admin: {
-        layout: 'horizontal',
-      },
-    },
-  ],
-}
-```

docs/fields/relationship.mdx

@@ -1,366 +0,0 @@
----
-title: Relationship Field
-label: Relationship
-order: 130
-desc: The Relationship field provides the ability to relate documents together. Learn how to use Relationship fields, see examples and options.
-keywords: relationship, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Relationship field is one of the most powerful fields Payload features. It provides for the
-  ability to easily relate documents together.
-</Banner>
-
-<LightDarkImage
-srcLight="https://payloadcms.com/images/docs/fields/relationship.png"
-srcDark="https://payloadcms.com/images/docs/fields/relationship-dark.png"
-alt="Shows a relationship field in the Payload admin panel"
-caption="Admin panel screenshot of a Relationship field"
-/>
-
-**Example uses:**
-
-- To add `Product` documents to an `Order` document
-- To allow for an `Order` to feature a `placedBy` relationship to either an `Organization` or `User` collection
-- To assign `Category` documents to `Post` documents
-
-### Config
-
-| 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 one or many collection `slug`s to be able to assign relationships to.                                                                                                 |
-| **`filterOptions`** | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options).                                                               |
-| **`hasMany`**       | Boolean when, 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](/docs/getting-started/concepts#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.                                                                                                  |
-| **`validate`**      | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                  |
-| **`index`**         | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                 |
-| **`hooks`**         | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                    |
-| **`access`**        | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                       |
-| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                              |
-| **`defaultValue`**  | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                          |
-| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                               |
-| **`required`**      | Require this field to have a value.                                                                                                                                           |
-| **`admin`**         | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                      |
-| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                     |
-
-_\* An asterisk denotes that a property is required._
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br />
-  The [Depth](/docs/getting-started/concepts#depth) parameter can be used to automatically populate
-  related documents that are returned by the API.
-</Banner>
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Relationship field type also
-allows for the following admin-specific properties:
-
-**`isSortable`**
-
-Set to `true` if you'd like this field to be sortable within the Admin UI using drag and drop (only works when `hasMany`
-is set to `true`).
-
-**`allowCreate`**
-
-Set to `false` if you'd like to disable the ability to create new documents from within the relationship field (hides
-the "Add new" button in the admin UI).
-
-**`sortOptions`**
-
-The `sortOptions` property allows you to define a default sorting order for the options within a Relationship field's
-dropdown. This can be particularly useful for ensuring that the most relevant options are presented first to the user.
-
-You can specify `sortOptions` in two ways:
-
-**As a string:**
-
-Provide a string to define a global default sort field for all relationship field dropdowns across different
-collections. You can prefix the field name with a minus symbol ("-") to sort in descending order.
-
-Example:
-
-```ts
-sortOptions: 'fieldName',
-```
-
-This configuration will sort all relationship field dropdowns by `"fieldName"` in ascending order.
-
-**As an object :**
-
-Specify an object where keys are collection slugs and values are strings representing the field names to sort by. This
-allows for different sorting fields for each collection's relationship dropdown.
-
-Example:
-
-```ts
-sortOptions: {
-  "pages"
-:
-  "fieldName1",
-    "posts"
-:
-  "-fieldName2",
-    "categories"
-:
-  "fieldName3"
-}
-```
-
-In this configuration:
-
-- Dropdowns related to `pages` will be sorted by `"fieldName1"` in ascending order.
-- Dropdowns for `posts` will use `"fieldName2"` for sorting in descending order (noted by the "-" prefix).
-- Dropdowns associated with `categories` will sort based on `"fieldName3"` in ascending order.
-
-Note: If `sortOptions` is not defined, the default sorting behavior of the Relationship field dropdown will be used.
-
-### Filtering relationship options
-
-Options can be dynamically limited by supplying a [query constraint](/docs/queries/overview), which will be used both
-for validating input and filtering available relationships in the UI.
-
-The `filterOptions` property can either be a `Where` query, or a function returning `true` to not filter, `false` to
-prevent all, or a `Where` query. When using a function, it will be
-called with an argument object with the following properties:
-
-| Property      | Description                                                                          |
-|---------------|--------------------------------------------------------------------------------------|
-| `relationTo`  | The `relationTo` to filter against (as defined on the field)                         |
-| `data`        | An object of the full collection or global document currently being edited           |
-| `siblingData` | An object of the document data limited to fields within the same parent to the field |
-| `id`          | The value of the collection `id`, will be `undefined` on create request              |
-| `user`        | The currently authenticated user object                                              |
-
-### Example
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'purchase',
-      type: 'relationship',
-      relationTo: ['products', 'services'],
-      filterOptions: ({ relationTo, siblingData }) => {
-        // returns a Where query dynamically by the type of relationship
-        if (relationTo === 'products') {
-          return {
-            stock: { greater_than: siblingData.quantity },
-          }
-        }
-
-        if (relationTo === 'services') {
-          return {
-            isAvailable: { equals: true },
-          }
-        }
-      },
-    },
-  ],
-}
-```
-
-You can learn more about writing queries [here](/docs/queries/overview).
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  When a relationship field has both <strong>filterOptions</strong> and a custom{' '}
-  <strong>validate</strong> function, the api will not validate <strong>filterOptions</strong>{' '}
-  unless you call the default relationship field validation function imported from{' '}
-  <strong>payload/fields/validations</strong> in your validate function.
-</Banner>
-
-### How the data is saved
-
-Given the variety of options possible within the `relationship` field type, the shape of the data needed for creating
-and updating these fields can vary. The following sections will describe the variety of data shapes that can arise from
-this field.
-
-#### Has One
-
-The most simple pattern of a relationship is to use `hasMany: false` with a `relationTo` that allows for only one type
-of collection.
-
-```ts
-{
-  slug: 'example-collection',
-    fields
-:
-  [
-    {
-      name: 'owner', // required
-      type: 'relationship', // required
-      relationTo: 'users', // required
-      hasMany: false,
-    }
-  ]
-}
-```
-
-The shape of the data to save for a document with the field configured this way would be:
-
-```json
-{
-  // ObjectID of the related user
-  "owner": "6031ac9e1289176380734024"
-}
-```
-
-When querying documents in this collection via REST API, you could query as follows:
-
-`?where[owner][equals]=6031ac9e1289176380734024`.
-
-#### Has One - Polymorphic
-
-Also known as **dynamic references**, in this configuration, the `relationTo` field is an array of Collection slugs that
-tells Payload which Collections are valid to reference.
-
-```ts
-{
-  slug: 'example-collection',
-    fields
-:
-  [
-    {
-      name: 'owner', // required
-      type: 'relationship', // required
-      relationTo: ['users', 'organizations'], // required
-      hasMany: false,
-    }
-  ]
-}
-```
-
-The shape of the data to save for a document with more than one relationship type would be:
-
-```json
-{
-  "owner": {
-    "relationTo": "organizations",
-    "value": "6031ac9e1289176380734024"
-  }
-}
-```
-
-Here is an example for how to query documents by this data (note the difference in referencing the `owner.value`):
-
-`?where[owner.value][equals]=6031ac9e1289176380734024`.
-
-You can also query for documents where a field has a relationship to a specific Collection:
-
-`?where[owners.relationTo][equals]=organizations`.
-
-This query would return only documents that have an owner relationship to organizations.
-
-#### Has Many
-
-The `hasMany` tells Payload that there may be more than one collection saved to the field.
-
-```ts
-{
-  slug: 'example-collection',
-    fields
-:
-  [
-    {
-      name: 'owners', // required
-      type: 'relationship', // required
-      relationTo: 'users', // required
-      hasMany: true,
-    }
-  ]
-}
-```
-
-To save the to `hasMany` relationship field we need to send an array of IDs:
-
-```json
-{
-  "owners": [
-    "6031ac9e1289176380734024",
-    "602c3c327b811235943ee12b"
-  ]
-}
-```
-
-When querying documents, the format does not change for arrays:
-
-`?where[owners][equals]=6031ac9e1289176380734024`.
-
-#### Has Many - Polymorphic
-
-```ts
-{
-  slug: 'example-collection',
-    fields
-:
-  [
-    {
-      name: 'owners', // required
-      type: 'relationship', // required
-      relationTo: ['users', 'organizations'], // required
-      hasMany: true,
-      required: true,
-    }
-  ]
-}
-```
-
-Relationship fields with `hasMany` set to more than one kind of collections save their data as an array of objects—each
-containing the Collection `slug` as the `relationTo` value, and the related document `id` for the `value`:
-
-```json
-{
-  "owners": [
-    {
-      "relationTo": "users",
-      "value": "6031ac9e1289176380734024"
-    },
-    {
-      "relationTo": "organizations",
-      "value": "602c3c327b811235943ee12b"
-    }
-  ]
-}
-```
-
-Querying is done in the same way as the earlier Polymorphic example:
-
-`?where[owners.value][equals]=6031ac9e1289176380734024`.
-
-#### Querying and Filtering Polymorphic Relationships
-
-Polymorphic and non-polymorphic relationships must be queried differently because of how the related data is stored and
-may be inconsistent across different collections. Because of this, filtering polymorphic relationship fields from the
-Collection List admin UI is limited to the `id` value.
-
-For a polymorphic relationship, the response will always be an array of objects. Each object will contain
-the `relationTo` and `value` properties.
-
-The data can be queried by the related document ID:
-
-`?where[field.value][equals]=6031ac9e1289176380734024`.
-
-Or by the related document Collection slug:
-
-`?where[field.relationTo][equals]=your-collection-slug`.
-
-However, you **cannot** query on any field values within the related document.
-Since we are referencing multiple collections, the field you are querying on may not exist and break the query.
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  You <strong>cannot</strong> query on a field within a polymorphic relationship as you would with a non-polymorphic relationship.
-</Banner>

docs/fields/rich-text.mdx

@@ -1,70 +0,0 @@
----
-title: Rich Text Field
-label: Rich Text
-order: 140
-desc: The Rich Text field allows dynamic content to be written through the Admin Panel. Learn how to use Rich Text fields, see examples and options.
-keywords: rich text, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Rich Text field is a powerful way to allow editors to write dynamic content. The content is
-  saved as JSON in the database and can be converted into any format, including HTML, that you need.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/richtext.png"
-  srcDark="https://payloadcms.com/images/docs/fields/richtext-dark.png"
-  alt="Shows a Rich Text field in the Payload admin panel"
-  caption="Admin panel screenshot of a Rich Text field"
-/>
-
-Payload's rich text field is built on an "adapter pattern" which lets you specify which rich text editor you'd like to use. 
-
-Right now, Payload is officially supporting two rich text editors:
-
-1. [SlateJS](/docs/rich-text/slate) - stable, backwards-compatible with 1.0
-2. [Lexical](/docs/rich-text/lexical) - beta, where things will be moving
-
-<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.</strong> Instead, you can invest your time and effort into learning the underlying open-source tools that will allow you to apply your learnings elsewhere as well.
-</Banner>
-
-### Config
-
-| Option             | Description                                                                                                                                             |
-| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                  |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                 |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)            |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.           |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                              |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.        |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                    |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                         |
-| **`required`**     | Require this field to have a value.                                                                                                                     |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                               |
-| **`editor`**       | Override the rich text editor specified in your base configuration for this field.                                                                      |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                               |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Rich Text editor allows for the following admin properties:
-
-**`placeholder`**
-
-Set this property to define a placeholder string in the text input.
-
-**`hideGutter`**
-
-Set this property to `true` to hide this field's gutter within the admin panel. The field gutter is rendered as a vertical line and padding, but often if this field is nested within a Group, Block, or Array, you may want to hide the gutter.
-
-**`rtl`**
-
-Override the default text direction of the Admin panel for this field. Set to `true` to force right-to-left text direction.
-
-### Editor-specific options
-
-For a ton more editor-specific options, including how to build custom rich text elements directly into your editor, take a look at either the [Slate docs](/docs/rich-text/slate) or the [Lexical docs](/docs/rich-text/lexical) depending on which editor you're using.

docs/fields/row.mdx

@@ -1,65 +0,0 @@
----
-title: Row Field
-label: Row
-order: 150
-desc: With the Row field you can arrange fields next to each other in the Admin Panel to help you customize your Dashboard.
-keywords: row, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Row field is presentational-only and only affects the Admin panel. By using it, you can
-  arrange fields next to each other horizontally.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/row.png"
-  srcDark="https://payloadcms.com/images/docs/fields/row-dark.png"
-  alt="Shows a row field in the Payload admin panel"
-  caption="Admin panel screenshot of a Row field"
-/>
-
-### Config
-
-| Option          | Description                                                                                                                                                                |
-| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`fields`** \* | Array of field types to nest within this Row.                                                                                                                              |
-| **`admin`**     | Admin-specific configuration excluding `description`, `readOnly`, and `hidden`. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
-| **`custom`**    | Extension point for adding custom data (e.g. for plugins)                                                                                                                  |
-
-_\* An asterisk denotes that a property is required._
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      type: 'row', // required
-      fields: [
-        // required
-        {
-          name: 'label',
-          type: 'text',
-          required: true,
-          admin: {
-            width: '50%',
-          },
-        },
-        {
-          name: 'value',
-          type: 'text',
-          required: true,
-          admin: {
-            width: '50%',
-          },
-        },
-      ],
-    },
-  ],
-}
-```

docs/fields/select.mdx

@@ -1,193 +0,0 @@
----
-title: Select Field
-label: Select
-order: 160
-desc: The Select field provides a dropdown-style interface for choosing options from a predefined list. Learn how to use Select fields, see examples and options.
-keywords: select, multi-select, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Select field provides a dropdown-style interface for choosing options from a predefined list
-  as an enumeration.
-</Banner>
-
-<LightDarkImage
-srcLight="https://payloadcms.com/images/docs/fields/select.png"
-srcDark="https://payloadcms.com/images/docs/fields/select-dark.png"
-alt="Shows a Select field in the Payload admin panel"
-caption="Admin panel screenshot of a Select field"
-/>
-
-### Config
-
-| Option             | Description                                                                                                                                                                   |
-|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                        |
-| **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string.                     |
-| **`hasMany`**      | Boolean when, if set to `true`, allows this field to have many selections instead of only one.                                                                                |
-| **`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.                                                                                                  |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                  |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.   |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                 |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                    |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                       |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                              |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                          |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                               |
-| **`required`**     | Require this field to have a value.                                                                                                                                           |
-| **`admin`**        | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                      |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                     |
-| **`enumName`**     | Custom enum name for this field when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined.                               |
-| **`dbName`**       | Custom table name (if `hasMany` set to `true`) for this field when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined. |
-
-_\* An asterisk denotes that a property is required._
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  Option values should be strings that do not contain hyphens or special characters due to GraphQL
-  enumeration naming constraints. Underscores are allowed. If you determine you need your option
-  values to be non-strings or contain special characters, they will be formatted accordingly before
-  being used as a GraphQL enum.
-</Banner>
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Select field type also allows
-for the following admin-specific properties:
-
-**`isClearable`**
-
-Set to `true` if you'd like this field to be clearable within the Admin UI.
-
-**`isSortable`**
-
-Set to `true` if you'd like this field to be sortable within the Admin UI using drag and drop. (Only works
-when `hasMany` is set to `true`)
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'selectedFeatures', // required
-      type: 'select', // required
-      hasMany: true,
-      admin: {
-        isClearable: true,
-        isSortable: true, // use mouse to drag and drop different values, and sort them according to your choice
-      },
-      options: [
-        {
-          label: 'Metallic Paint',
-          value: 'metallic_paint',
-        },
-        {
-          label: 'Alloy Wheels',
-          value: 'alloy_wheels',
-        },
-        {
-          label: 'Carbon Fiber Dashboard',
-          value: 'carbon_fiber_dashboard',
-        },
-      ],
-    },
-  ],
-}
-```
-
-### Customization
-
-The Select field UI component can be customized by providing a custom React component to the `components` object in the
-Base config.
-
-```ts
-export const CustomSelectField: Field = {
-  name: 'customSelectField',
-  type: 'select', // or 'text' if you have dynamic options
-  admin: {
-    components: {
-      Field: CustomSelectComponent({
-        options: [
-          {
-            label: 'Option 1',
-            value: '1',
-          },
-          {
-            label: 'Option 2',
-            value: '2',
-          },
-        ],
-      }),
-    },
-  }
-}
-```
-
-You can import the existing Select component directly from Payload, then extend and customize it as needed.
-
-```ts
-import * as React from 'react';
-import { SelectInput, useField } from 'payload/components/forms';
-import { useAuth } from 'payload/components/utilities';
-
-type CustomSelectProps = {
-  path: string;
-  options: {
-    label: string;
-    value: string;
-  }[];
-}
-
-export const CustomSelectComponent: React.FC<CustomSelectProps> = ({ path, options }) => {
-  const { value, setValue } = useField<string>({ path })
-  const { user } = useAuth()
-
-  const adjustedOptions = options.filter((option) => {
-    /*
-      A common use case for a custom select
-      is to show different options based on
-      the current user's role.
-    */
-    return option;
-  });
-
-  return (
-    <div>
-      <label className = "field-label" >
-      Custom
-  Select
-  < /label>
-  < SelectInput
-  path = { path }
-  name = { path }
-  options = { adjustedOptions }
-  value = { value }
-  onChange = {(e)
-=>
-  setValue(e.value)
-}
-  />
-  < /div>
-)
-}
-```
-
-If you are looking to create a dynamic select field, the following tutorial will walk you through the process of
-creating a custom select field that fetches its options from an external API.
-
-<VideoDrawer
-id='Efn9OxSjA6Y'
-label='How to Create a Custom Select Field'
-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.

docs/fields/tabs.mdx

@@ -1,87 +0,0 @@
----
-title: Tabs Field
-label: Tabs
-order: 170
-desc: The Tabs field is a great way to organize complex editing experiences into specific tab-based areas.
-keywords: tabs, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Tabs field is presentational-only and only affects the Admin panel (unless a tab is named). By
-  using it, you can place fields within a nice layout component that separates certain sub-fields by
-  a tabbed interface.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/tabs.png"
-  srcDark="https://payloadcms.com/images/docs/fields/tabs-dark.png"
-  alt="Shows a tabs field used to separate Hero and Page layout in the Payload admin panel"
-  caption="Tabs field type used to separate Hero fields from Page Layout"
-/>
-
-### Config
-
-| Option        | Description                                                                                                              |
-| ------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| **`tabs`** \* | Array of tabs to render within this Tabs field.                                                                          |
-| **`admin`**   | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
-| **`custom`**  | Extension point for adding custom data (e.g. for plugins)                                                                |
-
-#### Tab-specific Config
-
-Each tab must have either a `name` or `label` and the required `fields` array. You can also optionally pass a `description` to render within each individual tab.
-
-| Option              | Description                                                                                                                                                                                                  |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **`name`**          | Groups field data into an object when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                      |
-| **`label`**         | The label to render on the tab itself. Required when name is undefined, defaults to name converted to words.                                                                                                 |
-| **`fields`** \*     | The fields to render within this tab.                                                                                                                                                                        |
-| **`description`**   | Optionally render a description within this tab to describe the contents of the tab itself.                                                                                                                  |
-| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). (`name` must be present) |
-
-_\* An asterisk denotes that a property is required._
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      type: 'tabs', // required
-      tabs: [
-        // required
-        {
-          label: 'Tab One Label', // required
-          description: 'This will appear within the tab above the fields.',
-          fields: [
-            // required
-            {
-              name: 'someTextField',
-              type: 'text',
-              required: true,
-            },
-          ],
-        },
-        {
-          name: 'tabTwo',
-          label: 'Tab Two Label', // required
-          interfaceName: 'TabTwo', // optional (`name` must be present)
-          fields: [
-            // required
-            {
-              name: 'numberField', // accessible via tabTwo.numberField
-              type: 'number',
-              required: true,
-            },
-          ],
-        },
-      ],
-    },
-  ],
-}
-```

docs/fields/text.mdx

@@ -1,79 +0,0 @@
----
-title: Text Field
-label: Text
-order: 180
-desc: Text field types simply save a string to the database and provide the Admin panel with a text input. Learn how to use Text fields, see examples and options.
-keywords: text, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Text field type is one of the most commonly used fields. It saves a string to the database and
-  provides the Admin panel with a simple text input.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/text.png"
-  srcDark="https://payloadcms.com/images/docs/fields/text-dark.png"
-  alt="Shows a text field and read-only text field in the Payload admin panel"
-  caption="Admin panel screenshot of a Text field and read-only Text field"
-/>
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`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.                                                                                                                        |
-| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                                         |
-| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                                         |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-| **`hasMany`**      | Makes this field an ordered array of text instead of just a single text.                                                                                                                       |
-| **`minRows`**      | Minimum number of texts in the array, if `hasMany` is set to true.                                                                                                                        |
-| **`maxRows`**      | Maximum number of texts in the array, if `hasMany` is set to true.                                                                                                                        |
-_\* An asterisk denotes that a property is required._
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Text field type allows for the following `admin` properties:
-
-**`placeholder`**
-
-Set this property to define a placeholder string in the text input.
-
-**`autoComplete`**
-
-Set this property to a string that will be used for browser autocomplete.
-
-**`rtl`**
-
-Override the default text direction of the Admin panel for this field. Set to `true` to force right-to-left text direction.
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'pageTitle', // required
-      type: 'text', // required
-      required: true,
-    },
-  ],
-}
-```

docs/fields/textarea.mdx

@@ -1,77 +0,0 @@
----
-title: Textarea Field
-label: Textarea
-order: 190
-desc: Textarea field types save a string to the database, similar to the Text field type but equipped for longer text. Learn how to use Textarea fields, see examples and options.
-keywords: textarea, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Textarea field is almost identical to the Text field but it features a slightly larger input
-  that is better suited to edit longer text.
-</Banner>
-
-<LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/textarea.png"
-  srcDark="https://payloadcms.com/images/docs/fields/textarea-dark.png"
-  alt="Shows a textarea field and read-only textarea field in the Payload admin panel"
-  caption="Admin panel screenshot of a Textarea field and read-only Textarea field"
-/>
-
-### Config
-
-| Option             | Description                                                                                                                                                                                         |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
-| **`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.                                                                                                                        |
-| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                                         |
-| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                                         |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
-| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Admin config
-
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Textarea field type allows for the following `admin` properties:
-
-**`placeholder`**
-
-Set this property to define a placeholder string in the textarea.
-
-**`autoComplete`**
-
-Set this property to a string that will be used for browser autocomplete.
-
-**`rtl`**
-
-Override the default text direction of the Admin panel for this field. Set to `true` to force right-to-left text direction.
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'metaDescription', // required
-      type: 'textarea', // required
-      required: true,
-    },
-  ],
-}
-```

docs/fields/ui.mdx

@@ -1,60 +0,0 @@
----
-title: UI Field
-label: UI
-order: 200
-desc: UI fields are purely presentational and allow developers to customize the admin panel to a very fine degree, including adding actions and other functions.
-keywords: custom field, react component, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The UI (user interface) field gives you a ton of power to add your own React components directly
-  into the Admin panel, nested directly within your other fields. It has absolutely no effect on the
-  data of your documents. It is presentational-only.
-</Banner>
-
-This field is helpful if you need to build in custom functionality via React components within the Admin panel. Think of it as a way for you to "plug in" your own React components directly within your other fields, so you can provide your editors with new controls exactly where you want them to go.
-
-With this field, you can also inject custom `Cell` components that appear as additional columns within collections' List views.
-
-**Example uses:**
-
-- Add a custom message or block of text within the body of an Edit view to describe the purpose of surrounding fields
-- Add a "Refund" button to an Order's Edit view sidebar, which might make a fetch call to a custom `refund` endpoint
-- Add a "view page" button into a Pages List view to give editors a shortcut to view a page on the frontend of the site
-- Build a "clear cache" button or similar mechanism to manually clear caches of specific documents
-
-### Config
-
-| Option                          | Description                                                                                                            |
-| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| **`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](/docs/admin/components/#field-component)    |
-| **`admin.components.Cell`**     | React component to be rendered as a Cell within collection List views. [More](/docs/admin/components/#field-component) |
-| **`custom`**                    | Extension point for adding custom data (e.g. for plugins)                                                              |
-
-_\* An asterisk denotes that a property is required._
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'myCustomUIField', // required
-      type: 'ui', // required
-      admin: {
-        components: {
-          Field: MyCustomUIField,
-          Cell: MyCustomUICell,
-        },
-      },
-    },
-  ],
-}
-```

docs/fields/upload.mdx

@@ -1,118 +0,0 @@
----
-title: Upload Field
-label: Upload
-order: 210
-desc: Upload fields will allow a file to be uploaded, only from a collection supporting Uploads. Learn how to use Upload fields, see examples and options.
-keywords: upload, images media, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
----
-
-<Banner>
-  The Upload field allows for the selection of a Document from a collection supporting Uploads, and
-  formats the selection as a thumbnail in the Admin panel.
-</Banner>
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  To use this field, you need to have a Collection configured to allow Uploads. For more
-  information, [click here](/docs/upload/overview) to read about how to enable Uploads on a
-  collection by collection basis.
-</Banner>
-
-<LightDarkImage
-srcLight="https://payloadcms.com/images/docs/fields/upload.png"
-srcDark="https://payloadcms.com/images/docs/fields/upload-dark.png"
-alt="Shows an upload field in the Payload admin panel"
-caption="Admin panel screenshot of an Upload field"
-/>
-
-**Example uses:**
-
-- To provide a `Page` with a featured image
-- To allow for a `Product` to deliver a downloadable asset like PDF or MP3
-- To give a layout building block the ability to feature a background image
-
-### Config
-
-| 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>        |
-| **`filterOptions`**  | A query to filter which options appear in the UI and validate against. [More](#filtering-upload-options).                                                                   |
-| **`maxDepth`**       | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#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.                                                                                                |
-| **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
-| **`index`**          | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**      | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**          | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**         | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**         | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`**   | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**       | Require this field to have a value.                                                                                                                                         |
-| **`admin`**          | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                    |
-| **`custom`**         | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
-
-_\* An asterisk denotes that a property is required._
-
-### Example
-
-`collections/ExampleCollection.ts`
-
-```ts
-import { CollectionConfig } from 'payload/types'
-
-export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
-  fields: [
-    {
-      name: 'backgroundImage', // required
-      type: 'upload', // required
-      relationTo: 'media', // required
-      required: true,
-    },
-  ],
-}
-```
-
-### Filtering upload options
-
-Options can be dynamically limited by supplying a [query constraint](/docs/queries/overview), which will be used both
-for validating input and filtering available uploads in the UI.
-
-The `filterOptions` property can either be a `Where` query, or a function returning `true` to not filter, `false` to
-prevent all, or a `Where` query. When using a function, it will be
-called with an argument object with the following properties:
-
-| Property      | Description                                                                          |
-|---------------|--------------------------------------------------------------------------------------|
-| `relationTo`  | The `relationTo` to filter against (as defined on the field)                         |
-| `data`        | An object of the full collection or global document currently being edited           |
-| `siblingData` | An object of the document data limited to fields within the same parent to the field |
-| `id`          | The value of the collection `id`, will be `undefined` on create request              |
-| `user`        | The currently authenticated user object                                              |
-
-**Example:**
-
-```ts
-const uploadField = {
-  name: 'image',
-  type: 'upload',
-  relationTo: 'media',
-  filterOptions: {
-    mimeType: { contains: 'image' },
-  },
-}
-```
-
-You can learn more about writing queries [here](/docs/queries/overview).
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  When an upload field has both <strong>filterOptions</strong> and a custom{' '}
-  <strong>validate</strong> function, the api will not validate <strong>filterOptions</strong>{' '}
-  unless you call the default upload field validation function imported from{' '}
-  <strong>payload/fields/validations</strong> in your validate function.
-</Banner>

docs/getting-started/concepts.mdx

@@ -1,164 +0,0 @@
----
-title: Payload Concepts
-label: Concepts
-order: 20
-desc: Payload is based around a small and intuitive set of concepts. Key concepts include collections, globals, fields and more.
-keywords: documentation, getting started, guide, Content Management System, cms, headless, javascript, node, react, express
----
-
-Payload is based around a small and intuitive set of concepts. Before starting to work with Payload, it's a good idea to familiarize yourself with the following:
-
-### Config
-
-<Banner type="info">The Payload config is where you configure everything that Payload does.</Banner>
-
-By default, the Payload config lives in the root folder of your code and is named `payload.config.js` (`payload.config.ts` if you're using TypeScript), but you can customize its name and where you store it. You can write full functions and even full React components right into your config.
-
-### Collections
-
-<Banner type="info">
-  A Collection represents a type of content that Payload will store and can contain many documents.
-</Banner>
-
-Collections define the shape of your data as well as all functionalities attached to that data. They will contain one or many "documents", all corresponding with the same fields and functionalities that you define.
-
-They can represent anything you can store in a database - for example - pages, posts, users, people, orders, categories, events, customers, transactions, and anything else your app needs.
-
-### Globals
-
-<Banner type="info">
-  A Global is a "one-off" piece of content that is perfect for storing navigational structures,
-  themes, top-level meta data, and more.
-</Banner>
-
-Globals are in many ways similar to Collections, but there is only ever **one** instance of a Global, whereas Collections can contain many documents.
-
-### Fields
-
-<Banner type="info">
-  Fields are the building blocks of Payload. Collections and Globals both use Fields to define the
-  shape of the data that they store.
-</Banner>
-
-Payload comes with [many different field types](../fields/overview) that give you a ton of flexibility while designing your API. Each Field type has its own potential properties that allow you to customize how they work.
-
-### Hooks
-
-<Banner type="info">
-  Hooks are where you can "tie in" to existing Payload actions to perform your own additional logic
-  or modify how Payload operates altogether.
-</Banner>
-
-Hooks are an extremely powerful concept and are central to extending and customizing your app. Payload provides a wide variety of hooks which you can utilize. For example, imagine if you'd like to send an email every time a document is created in your Orders collection. To do so, you can add an `afterChange` hook function to your Orders collection that receives the Order data and allows you to send an email accordingly.
-
-There are many more potential reasons to use Hooks. For more, visit the [Hooks documentation](/docs/hooks/overview).
-
-### Access Control
-
-<Banner type="info">
-  Access Control refers to Payload's system of defining who can do what to your API.
-</Banner>
-
-Access Control is extremely powerful but easy and intuitive to manage. You can easily define your own full-blown RBAC (role-based access control) or any other access control pattern that your scenario requires. No conventions or structure is forced on you whatsoever.
-
-For more, visit the [Access Control documentation](/docs/access-control/overview).
-
-### Depth
-
-<Banner type="info">
-  "Depth" gives you control over how many levels down related documents should be automatically
-  populated when retrieved.
-</Banner>
-
-You can specify population `depth` via query parameter in the REST API and by an option in the local API. _Depth has no effect in the GraphQL API, because there, depth is based on the shape of your queries._
-It is also possible to limit the depth for specific `relation` and `upload` fields using the `maxDepth` property in your configuration.
-**For example, let's look at the following Collections:** `departments`, `users`, `posts`
-
-```
-// type: 'relationship' fields are equal to 1 depth level
-
-{
-	slug: 'posts',
-	fields: [
-		{
-			name: 'title',
-			type: 'text',
-		},
-		{
-			name: 'author',
-			label: 'Post Author',
-			type: 'relationship',
-			relationTo: 'users',
-		}
-	]
-}
-
-{
-	slug: 'users',
-	fields: [
-		{
-			name: 'email',
-			type: 'email',
-		},
-		{
-			name: 'department'
-			type: 'relationship',
-			relationTo: 'departments'
-		}
-	]
-}
-
-{
-	slug: 'departments',
-	fields: [
-		{
-			name: 'name'
-			type: 'text',
-		}
-	]
-}
-```
-
-If you were to query the Posts endpoint at, say, `http://localhost:3000/api/posts?depth=1`, you will retrieve Posts with populations one level deep. This depth parameter can be thought of as N, where N is the number of levels you want to populate. To populate one level further, you would simply specify N+1 as the depth. A returned result may look like the following:
-
-```
-// ?depth=1
-
-{
-  id: '5ae8f9bde69e394e717c8832',
-  title: 'This post sucks',
-  author: {
-    id: '5f7dd05cd50d4005f8bcab17',
-    email: 'spiderman@superheroes.gov',
-    department: '5e3ca05cd50d4005f8bdab15'
-  }
-}
-```
-
-Notice how the `user.author` is fully populated, but `user.author.department` is left as a document ID? That's because the User collection counted as the first level of `depth` and got populated—but then prevented any further populations from taking place.
-
-To populate `user.author.department` in it's entirety you could specify `?depth=2` or _higher_.
-
-```
-// ?depth=2
-
-{
-  id: '5ae8f9bde69e394e717c8832',
-  title: 'This post sucks',
-  author: {
-    id: '5f7dd05cd50d4005f8bcab17',
-    email: 'spiderman@superheroes.gov',
-    department: {
-      id: '5e3ca05cd50d4005f8bdab15',
-      name: 'Marvel'
-    }
-  }
-}
-```
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  When access control on collections prevents relationship fields from populating, the API response
-  will contain the relationship id instead of the full document.
-</Banner>