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

Reverts payloadcms/payload#8110

.eslintrc.js

@@ -0,0 +1,38 @@
+module.exports = {
+  extends: ['@payloadcms'],
+  overrides: [
+    {
+      extends: ['plugin:@typescript-eslint/disable-type-checked'],
+      files: ['*.js', '*.cjs', '*.json', '*.md', '*.yml', '*.yaml'],
+    },
+    {
+      files: ['packages/eslint-config-payload/**'],
+      rules: {
+        'perfectionist/sort-objects': 'off',
+      },
+    },
+    {
+      files: ['package.json', 'tsconfig.json'],
+      rules: {
+        'perfectionist/sort-array-includes': 'off',
+        'perfectionist/sort-astro-attributes': 'off',
+        'perfectionist/sort-classes': 'off',
+        'perfectionist/sort-enums': 'off',
+        'perfectionist/sort-exports': 'off',
+        'perfectionist/sort-imports': 'off',
+        'perfectionist/sort-interfaces': 'off',
+        'perfectionist/sort-jsx-props': 'off',
+        'perfectionist/sort-keys': 'off',
+        'perfectionist/sort-maps': 'off',
+        'perfectionist/sort-named-exports': 'off',
+        'perfectionist/sort-named-imports': 'off',
+        'perfectionist/sort-object-types': 'off',
+        'perfectionist/sort-objects': 'off',
+        'perfectionist/sort-svelte-attributes': 'off',
+        'perfectionist/sort-union-types': 'off',
+        'perfectionist/sort-vue-attributes': 'off',
+      },
+    },
+  ],
+  root: true,
+}

.git-blame-ignore-revs

@@ -16,15 +16,3 @@ fb7d1be2f3325d076b7c967b1730afcef37922c2
 
 # lint and format create-payload-app
 5fd3d430001efe86515262ded5e26f00c1451181
-
-# 3.0 prettier & lint everywhere
-6789e61488a1d3de56f472ac3214faf344030005
-
-# 3.0 prettier & lint everywhere again
-83fd4c66222d7846eeb5cc332dfa99bf1e830831
-
-# Upgrade to typescript-eslint v8, then prettier & lint everywhere
-86fdad0bb8ab27810599c8a32f3d8cba1341e1df
-
-# Prettier and lint remaining db packages
-7fd736ea5b2e9fc4ef936e9dc9e5e3d722f6d8bf

.github/CODEOWNERS

@@ -1,23 +1,26 @@
 # Order matters. The last matching pattern takes precedence.
-# Approvals are not required currently but may be enabled in the future.
 
-### Package Exports ###
-/**/exports/ @denolfe @jmikrut @DanRibbens
+### Core ###
 
-### Packages ###
-/packages/plugin-cloud*/src/ @denolfe
-/packages/email-*/src/ @denolfe
-/packages/storage-*/src/ @denolfe
-/packages/create-payload-app/src/ @denolfe
-/packages/eslint-*/ @denolfe @AlessioGr
+### Adapters ###
+/packages/richtext-*/ @AlessioGr
+
+### Plugins ###
+/packages/plugin-cloud*/ @denolfe
 
 ### Templates ###
-/templates/_data/ @denolfe
-/templates/_template/ @denolfe
+/templates/ @jacobsfletch @denolfe
+
+### Misc ###
+/packages/create-payload-app/ @denolfe
+/packages/eslint-*/ @denolfe
 
 ### Build Files ###
+/**/package.json @denolfe
+
 /tsconfig.json @denolfe
 /**/tsconfig*.json @denolfe
+
 /jest.config.js @denolfe
 /**/jest.config.js @denolfe
 
@@ -25,5 +28,5 @@
 /package.json @denolfe
 /scripts/ @denolfe
 /.husky/ @denolfe
-/.vscode/ @denolfe @AlessioGr
+/.vscode/ @denolfe
 /.github/ @denolfe

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -1,47 +0,0 @@
-name: Bug Report
-description: Create a bug report for Payload
-labels: ['[possible-bug]']
-body:
-  - type: markdown
-    attributes:
-      value: |
-        *Note:* Feature requests should be opened as [discussions](https://github.com/payloadcms/payload/discussions/new?category=feature-requests-ideas).
-  - type: input
-    id: reproduction-link
-    attributes:
-      label: Link to reproduction
-      description: Want us to look into your issue faster? Follow the [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md) for more information.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Describe the Bug
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: To Reproduce
-      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: input
-    id: version
-    attributes:
-      label: Payload Version
-      description: What version of Payload are you running?
-    validations:
-      required: true
-  - type: input
-    id: adapters-plugins
-    attributes:
-      label: Adapters and Plugins
-      description: What adapters and plugins are you using? ie. db-mongodb, db-postgres, bundler-webpack, etc.
-  - 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/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

@@ -0,0 +1,47 @@
+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: |
+        ONLY CRITICAL bugs will be fixed in v2.
+  - type: input
+    id: reproduction-link
+    attributes:
+      label: Link to reproduction
+      description: Want us to look into your issue faster? Follow the [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md) for more information.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      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: input
+    id: version
+    attributes:
+      label: Payload Version
+      description: What version of Payload are you running?
+    validations:
+      required: true
+  - type: input
+    id: adapters-plugins
+    attributes:
+      label: Adapters and Plugins
+      description: What adapters and plugins are you using? ie. db-mongodb, db-postgres, bundler-webpack, etc.
+  - 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/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/.prettierrc.js

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

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

@@ -21,7 +21,7 @@ inputs:
   skip-label:
     description: Skip commenting if any of the given label are present. Multiple labels can be separated by commas.
     required: false
-    default: 'dependencies'
+    default: "dependencies"
   tag-filter:
     description: |
       Filter tags by a regular expression. Must be escaped. e.g. 'v\\d' to isolate tags between major versions.

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

@@ -1,15 +1,15 @@
 {
   "name": "release-commenter",
   "version": "0.0.0",
-  "private": true,
   "description": "GitHub Action to automatically comment on PRs and Issues when a fix is released.",
-  "license": "MIT",
   "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",
-    "clean": "rimraf dist",
     "test": "jest"
   },
   "dependencies": {

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

@@ -314,7 +314,7 @@ describe('tests', () => {
         require('./index')
       })
 
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
+      await new Promise<void>(resolve => setImmediate(() => resolve()))
 
       expect(github.getOctokit).toHaveBeenCalled()
       expect(mockOctokit.rest.repos.compareCommits.mock.calls).toEqual([
@@ -335,7 +335,7 @@ describe('tests', () => {
         require('./index')
       })
 
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
+      await new Promise<void>(resolve => setImmediate(() => resolve()))
 
       expect(github.getOctokit).toHaveBeenCalled()
       expect(mockOctokit.rest.issues.createComment).not.toHaveBeenCalled()
@@ -373,7 +373,7 @@ describe('tests', () => {
         require('./index')
       })
 
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
+      await new Promise<void>(resolve => setImmediate(() => resolve()))
 
       expect(github.getOctokit).toHaveBeenCalled()
 
@@ -390,7 +390,7 @@ describe('tests', () => {
         require('./index')
       })
 
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
+      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

@@ -44,7 +44,7 @@ const releaseTagTemplateRegex = /{release_tag}/g
       core.info(`Matched string from filter: ${regexMatch}`)
 
       releases = releases
-        .filter((release) => {
+        .filter(release => {
           const match = release.tag_name.match(regexMatch)?.[0]
           return match
         })
@@ -96,8 +96,8 @@ const releaseTagTemplateRegex = /{release_tag}/g
         ?.split(releaseTagTemplateRegex)
         .join(currentRelease.tag_name)
         ?.split(',')
-        ?.map((l) => l.trim())
-        .filter((l) => l)
+        ?.map(l => l.trim())
+        .filter(l => l)
 
     const labels = parseLabels(labelTemplate)
     const skipLabels = parseLabels(skipLabelTemplate)
@@ -105,7 +105,7 @@ const releaseTagTemplateRegex = /{release_tag}/g
     const linkedIssuesPrs = new Set<number>()
 
     await Promise.all(
-      commits.map((commit) =>
+      commits.map(commit =>
         (async () => {
           const query = `
             {
@@ -204,12 +204,12 @@ const releaseTagTemplateRegex = /{release_tag}/g
           core.info(`Checking commit: ${payload.repository.html_url}/commit/${commit.sha}`)
 
           const associatedClosedPREdges = response.resource.associatedPullRequests.edges.filter(
-            (e) => e.node.state === 'MERGED',
+            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    ')}`,
+              `  Associated Merged PRs:\n    ${associatedClosedPREdges.map(pr => `${payload.repository.html_url}/pull/${pr.node.number}`).join('\n    ')}`,
             )
           } else {
             core.info('  No associated merged PRs')
@@ -218,7 +218,7 @@ const releaseTagTemplateRegex = /{release_tag}/g
           const html = [
             response.resource.messageHeadlineHTML,
             response.resource.messageBodyHTML,
-            ...associatedClosedPREdges.map((pr) => pr.node.bodyHTML),
+            ...associatedClosedPREdges.map(pr => pr.node.bodyHTML),
           ].join(' ')
 
           for (const match of html.matchAll(closesMatcher)) {
@@ -243,7 +243,7 @@ const releaseTagTemplateRegex = /{release_tag}/g
             }
             // a skip labels is present on this PR
             if (
-              skipLabels?.some((l) => associatedPR.node.labels.nodes.some(({ name }) => name === l))
+              skipLabels?.some(l => associatedPR.node.labels.nodes.some(({ name }) => name === l))
             ) {
               continue
             }
@@ -256,7 +256,7 @@ const releaseTagTemplateRegex = /{release_tag}/g
             // 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)
+              .filter(node => !node.isCrossRepository)
               .reverse()
             for (const link of links) {
               if (seen.has(link.subject.number)) {
@@ -277,7 +277,7 @@ const releaseTagTemplateRegex = /{release_tag}/g
 
     core.info(
       `Final issues/PRs to be commented on: \n${Array.from(linkedIssuesPrs)
-        .map((num) => `  ${payload.repository.html_url}/pull/${num}`)
+        .map(num => `  ${payload.repository.html_url}/pull/${num}`)
         .join('\n')}`,
     )
 

.github/actions/setup/action.yml

@@ -1,48 +0,0 @@
-name: Setup node and pnpm
-description: Configure the Node.js and pnpm versions
-
-inputs:
-  node-version:
-    description: 'The Node.js version to use'
-    required: true
-    default: 22.6.2
-  pnpm-version:
-    description: 'The pnpm version to use'
-    required: true
-    default: 9.7.1
-
-runs:
-  using: composite
-  steps:
-    # https://github.com/actions/virtual-environments/issues/1187
-    - name: tune linux network
-      shell: bash
-      run: sudo ethtool -K eth0 tx off rx off
-
-    - name: Setup Node@${{ inputs.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ inputs.node-version }}
-
-    - name: Install pnpm
-      uses: pnpm/action-setup@v4
-      with:
-        version: ${{ inputs.pnpm-version }}
-        run_install: false
-
-    - name: Get pnpm store directory
-      shell: bash
-      run: |
-        echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-    - name: Setup pnpm cache
-      uses: actions/cache@v4
-      with:
-        path: ${{ env.STORE_PATH }}
-        key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-        restore-keys: |
-          pnpm-store-
-          pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-
-    - shell: bash
-      run: pnpm install

.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-lock.yaml

@@ -20,7 +20,7 @@ importers:
         version: 7.5.1
       '@swc/jest':
         specifier: ^0.2.36
-        version: 0.2.36(@swc/core@1.7.26)
+        version: 0.2.36(@swc/core@1.7.23)
       '@types/jest':
         specifier: ^27.5.2
         version: 27.5.2
@@ -44,13 +44,62 @@ importers:
         version: 7.32.0
       jest:
         specifier: ^29.7.0
-        version: 29.7.0(@types/node@20.16.5)
+        version: 29.7.0(@types/node@20.16.5)(node-notifier@8.0.2)
       prettier:
         specifier: ^3.3.3
         version: 3.3.3
       ts-jest:
         specifier: ^26.5.6
-        version: 26.5.6(jest@29.7.0(@types/node@20.16.5))(typescript@4.9.5)
+        version: 26.5.6(jest@29.7.0(@types/node@20.16.5)(node-notifier@8.0.2))(typescript@4.9.5)
+      typescript:
+        specifier: ^4.9.5
+        version: 4.9.5
+
+  actions/triage:
+    dependencies:
+      '@actions/core':
+        specifier: ^1.3.0
+        version: 1.10.1
+      '@actions/github':
+        specifier: ^5.0.0
+        version: 5.1.1
+    devDependencies:
+      '@octokit/webhooks-types':
+        specifier: ^7.5.1
+        version: 7.5.1
+      '@swc/jest':
+        specifier: ^0.2.36
+        version: 0.2.36(@swc/core@1.7.23)
+      '@types/jest':
+        specifier: ^27.5.2
+        version: 27.5.2
+      '@types/node':
+        specifier: ^20.16.5
+        version: 20.16.5
+      '@typescript-eslint/eslint-plugin':
+        specifier: ^4.33.0
+        version: 4.33.0(@typescript-eslint/parser@4.33.0(eslint@7.32.0)(typescript@4.9.5))(eslint@7.32.0)(typescript@4.9.5)
+      '@typescript-eslint/parser':
+        specifier: ^4.33.0
+        version: 4.33.0(eslint@7.32.0)(typescript@4.9.5)
+      '@vercel/ncc':
+        specifier: 0.38.1
+        version: 0.38.1
+      concurrently:
+        specifier: ^8.2.2
+        version: 8.2.2
+      eslint:
+        specifier: ^7.32.0
+        version: 7.32.0
+      jest:
+        specifier: ^29.7.0
+        version: 29.7.0(@types/node@20.16.5)(node-notifier@8.0.2)
+      prettier:
+        specifier: ^3.3.3
+        version: 3.3.3
+      ts-jest:
+        specifier: ^26.5.6
+        version: 26.5.6(jest@29.7.0(@types/node@20.16.5)(node-notifier@8.0.2))(typescript@4.9.5)
       typescript:
         specifier: ^4.9.5
         version: 4.9.5
@@ -421,68 +470,68 @@ packages:
   '@sinonjs/fake-timers@10.3.0':
     resolution: {integrity: sha512-V4BG07kuYSUkTCSBHG8G8TNhM+F19jXFWnQtzj+we8DrkpSBCee9Z3Ms8yiGer/dlmhe35/Xdgyo3/0rQKg7YA==}
 
-  '@swc/core-darwin-arm64@1.7.26':
-    resolution: {integrity: sha512-FF3CRYTg6a7ZVW4yT9mesxoVVZTrcSWtmZhxKCYJX9brH4CS/7PRPjAKNk6kzWgWuRoglP7hkjQcd6EpMcZEAw==}
+  '@swc/core-darwin-arm64@1.7.23':
+    resolution: {integrity: sha512-yyOHPfti6yKlQulfVWMt7BVKst+SyEZYCWuQSGMn1KgmNCH/bYufRWfQXIhkGSj44ZkEepJmsJ8tDyIb4k5WyA==}
     engines: {node: '>=10'}
     cpu: [arm64]
     os: [darwin]
 
-  '@swc/core-darwin-x64@1.7.26':
-    resolution: {integrity: sha512-az3cibZdsay2HNKmc4bjf62QVukuiMRh5sfM5kHR/JMTrLyS6vSw7Ihs3UTkZjUxkLTT8ro54LI6sV6sUQUbLQ==}
+  '@swc/core-darwin-x64@1.7.23':
+    resolution: {integrity: sha512-GzqHwQ0Y1VyjdI/bBKFX2GKm5HD3PIB6OhuAQtWZMTtEr2yIrlT0YK2T+XKh7oIg31JwxGBeQdBk3KTI7DARmQ==}
     engines: {node: '>=10'}
     cpu: [x64]
     os: [darwin]
 
-  '@swc/core-linux-arm-gnueabihf@1.7.26':
-    resolution: {integrity: sha512-VYPFVJDO5zT5U3RpCdHE5v1gz4mmR8BfHecUZTmD2v1JeFY6fv9KArJUpjrHEEsjK/ucXkQFmJ0jaiWXmpOV9Q==}
+  '@swc/core-linux-arm-gnueabihf@1.7.23':
+    resolution: {integrity: sha512-qwX4gB41OS6/OZkHcpTqLFGsdmvoZyffnJIlgB/kZKwH3lfeJWzv6vx57zXtNpM/t7GoQEe0VZUVdmNjxSxBZw==}
     engines: {node: '>=10'}
     cpu: [arm]
     os: [linux]
 
-  '@swc/core-linux-arm64-gnu@1.7.26':
-    resolution: {integrity: sha512-YKevOV7abpjcAzXrhsl+W48Z9mZvgoVs2eP5nY+uoMAdP2b3GxC0Df1Co0I90o2lkzO4jYBpTMcZlmUXLdXn+Q==}
+  '@swc/core-linux-arm64-gnu@1.7.23':
+    resolution: {integrity: sha512-TsrbUZdMaUwzI7+g/8rHPLWbntMKYSu5Bn5IBSqVKPeyqaXxNnlIUnWXgXcUcRAc+T+Y8ADfr7EiFz9iz5DuSA==}
     engines: {node: '>=10'}
     cpu: [arm64]
     os: [linux]
 
-  '@swc/core-linux-arm64-musl@1.7.26':
-    resolution: {integrity: sha512-3w8iZICMkQQON0uIcvz7+Q1MPOW6hJ4O5ETjA0LSP/tuKqx30hIniCGOgPDnv3UTMruLUnQbtBwVCZTBKR3Rkg==}
+  '@swc/core-linux-arm64-musl@1.7.23':
+    resolution: {integrity: sha512-JEdtwdthazKq4PBz53KSubwwK8MvqODAihGSAzc8u3Unq4ojcvaS8b0CwLBeD+kTQ78HpxOXTt3DsFIxpgaCAA==}
     engines: {node: '>=10'}
     cpu: [arm64]
     os: [linux]
 
-  '@swc/core-linux-x64-gnu@1.7.26':
-    resolution: {integrity: sha512-c+pp9Zkk2lqb06bNGkR2Looxrs7FtGDMA4/aHjZcCqATgp348hOKH5WPvNLBl+yPrISuWjbKDVn3NgAvfvpH4w==}
+  '@swc/core-linux-x64-gnu@1.7.23':
+    resolution: {integrity: sha512-V51gFPWaVAHbI1yg9ahsoya3aB4uawye3SZ5uQWgcP7wdCdiv60dw4F5nuPJf5Z1oXD3U/BslXuamv8Oh9vXqQ==}
     engines: {node: '>=10'}
     cpu: [x64]
     os: [linux]
 
-  '@swc/core-linux-x64-musl@1.7.26':
-    resolution: {integrity: sha512-PgtyfHBF6xG87dUSSdTJHwZ3/8vWZfNIXQV2GlwEpslrOkGqy+WaiiyE7Of7z9AvDILfBBBcJvJ/r8u980wAfQ==}
+  '@swc/core-linux-x64-musl@1.7.23':
+    resolution: {integrity: sha512-BBqQi4+UdeRqag3yM4IJjaHG4yc1o3l9ksENHToE0o/u2DT0FY5+K/DiYGZLC1JHbSFzNqRCYsa7DIzRtZ0A1A==}
     engines: {node: '>=10'}
     cpu: [x64]
     os: [linux]
 
-  '@swc/core-win32-arm64-msvc@1.7.26':
-    resolution: {integrity: sha512-9TNXPIJqFynlAOrRD6tUQjMq7KApSklK3R/tXgIxc7Qx+lWu8hlDQ/kVPLpU7PWvMMwC/3hKBW+p5f+Tms1hmA==}
+  '@swc/core-win32-arm64-msvc@1.7.23':
+    resolution: {integrity: sha512-JPk6pvCKncL6bXG7p+NLZf8PWx4FakVvKNdwGeMrYunb+yk1IZf7qf9LJk8+GDGF5QviDXPs8opZrTrfsW80fA==}
     engines: {node: '>=10'}
     cpu: [arm64]
     os: [win32]
 
-  '@swc/core-win32-ia32-msvc@1.7.26':
-    resolution: {integrity: sha512-9YngxNcG3177GYdsTum4V98Re+TlCeJEP4kEwEg9EagT5s3YejYdKwVAkAsJszzkXuyRDdnHUpYbTrPG6FiXrQ==}
+  '@swc/core-win32-ia32-msvc@1.7.23':
+    resolution: {integrity: sha512-2Whxi8d+bLQBzJcQ5qYPHlk02YYVGsMVav0fWk+FnX2z1QRREIu1L1xvrpi7gBpjXp6BIU40ya8GiKeekNT2bg==}
     engines: {node: '>=10'}
     cpu: [ia32]
     os: [win32]
 
-  '@swc/core-win32-x64-msvc@1.7.26':
-    resolution: {integrity: sha512-VR+hzg9XqucgLjXxA13MtV5O3C0bK0ywtLIBw/+a+O+Oc6mxFWHtdUeXDbIi5AiPbn0fjgVJMqYnyjGyyX8u0w==}
+  '@swc/core-win32-x64-msvc@1.7.23':
+    resolution: {integrity: sha512-82fARk4/yJ40kwWKY/gdKDisPdtgJE9jgpl/vkNG3alyJxrCzuNM7+CtiKoYbXLeqM8GQTS3wlvCaJu9oQ8dag==}
     engines: {node: '>=10'}
     cpu: [x64]
     os: [win32]
 
-  '@swc/core@1.7.26':
-    resolution: {integrity: sha512-f5uYFf+TmMQyYIoxkn/evWhNGuUzC730dFwAKGwBVHHVoPyak1/GvJUm6i1SKl+2Hrj9oN0i3WSoWWZ4pgI8lw==}
+  '@swc/core@1.7.23':
+    resolution: {integrity: sha512-VDNkpDvDlreGh2E3tlDj8B3piiuLhhQA/7rIVZpiLUvG1YpucAa6N7iDXA7Gc/+Hah8spaCg/qvEaBkCmcIYCQ==}
     engines: {node: '>=10'}
     peerDependencies:
       '@swc/helpers': '*'
@@ -719,8 +768,8 @@ packages:
     resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==}
     engines: {node: '>=10'}
 
-  caniuse-lite@1.0.30001660:
-    resolution: {integrity: sha512-GacvNTTuATm26qC74pt+ad1fW15mlQ/zuTzzY1ZoIzECTP8HURDfF43kNxPgf7H1jmelCBQTTbBNxdSXOA7Bqg==}
+  caniuse-lite@1.0.30001657:
+    resolution: {integrity: sha512-DPbJAlP8/BAXy3IgiWmZKItubb3TYGP0WscQQlVGIfT4s/YlFYVuJgyOsQNP7rJRChx/qdMeLJQJP0Sgg2yjNA==}
 
   chalk@2.4.2:
     resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==}
@@ -741,8 +790,8 @@ packages:
     resolution: {integrity: sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==}
     engines: {node: '>=8'}
 
-  cjs-module-lexer@1.4.1:
-    resolution: {integrity: sha512-cuSVIHi9/9E/+821Qjdvngor+xpnlwnuwIyZOaLmHBVdXL+gP+I6QQB9VkO7RI77YIcTV+S1W9AreJ5eN63JBA==}
+  cjs-module-lexer@1.4.0:
+    resolution: {integrity: sha512-N1NGmowPlGBLsOZLPvm48StN04V4YvQRL0i6b7ctrVY3epjP/ct7hFLOItz6pDIvRjwpfPxi52a2UWV2ziir8g==}
 
   cliui@8.0.1:
     resolution: {integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==}
@@ -792,8 +841,8 @@ packages:
     resolution: {integrity: sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw==}
     engines: {node: '>=0.11'}
 
-  debug@4.3.7:
-    resolution: {integrity: sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==}
+  debug@4.3.6:
+    resolution: {integrity: sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==}
     engines: {node: '>=6.0'}
     peerDependencies:
       supports-color: '*'
@@ -839,8 +888,8 @@ packages:
     resolution: {integrity: sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==}
     engines: {node: '>=6.0.0'}
 
-  electron-to-chromium@1.5.23:
-    resolution: {integrity: sha512-mBhODedOXg4v5QWwl21DjM5amzjmI1zw9EPrPK/5Wx7C8jt33bpZNrC7OhHUG3pxRtbLpr3W2dXT+Ph1SsfRZA==}
+  electron-to-chromium@1.5.15:
+    resolution: {integrity: sha512-Z4rIDoImwEJW+YYKnPul4DzqsWVqYetYVN3XqDmRpgV0mjz0hYTaeeh+8/9CL1bk3AHYmF4freW/NTiVoXA2gA==}
 
   emittery@0.13.1:
     resolution: {integrity: sha512-DeWwawk6r5yR9jFgnDKYt4sLS0LmHJJi3ZOnb5/JdbYwj3nW+FxQnHIjhBKz8YLC7oRNPVM9NQ47I3CVx34eqQ==}
@@ -1034,6 +1083,9 @@ packages:
   graceful-fs@4.2.11:
     resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==}
 
+  growly@1.3.0:
+    resolution: {integrity: sha512-+xGQY0YyAWCnqy7Cd++hc2JqMYzlm0dG30Jd0beaA64sROr8C4nt8Yc9V5Ro3avlSUDTN0ulqP/VBKi1/lLygw==}
+
   has-flag@3.0.0:
     resolution: {integrity: sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==}
     engines: {node: '>=4'}
@@ -1092,6 +1144,11 @@ packages:
     resolution: {integrity: sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==}
     engines: {node: '>= 0.4'}
 
+  is-docker@2.2.1:
+    resolution: {integrity: sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==}
+    engines: {node: '>=8'}
+    hasBin: true
+
   is-extglob@2.1.1:
     resolution: {integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==}
     engines: {node: '>=0.10.0'}
@@ -1120,6 +1177,10 @@ packages:
     resolution: {integrity: sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==}
     engines: {node: '>=8'}
 
+  is-wsl@2.2.0:
+    resolution: {integrity: sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==}
+    engines: {node: '>=8'}
+
   isexe@2.0.0:
     resolution: {integrity: sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==}
 
@@ -1394,8 +1455,8 @@ packages:
     engines: {node: '>=10'}
     hasBin: true
 
-  ms@2.1.3:
-    resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==}
+  ms@2.1.2:
+    resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==}
 
   natural-compare@1.4.0:
     resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==}
@@ -1412,6 +1473,9 @@ packages:
   node-int64@0.4.0:
     resolution: {integrity: sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==}
 
+  node-notifier@8.0.2:
+    resolution: {integrity: sha512-oJP/9NAdd9+x2Q+rfphB2RJCHjod70RcRLjosiPMMu5gjIfwVnOUGq2nbTjTUbmy0DJ/tFIVT30+Qe3nzl4TJg==}
+
   node-releases@2.0.18:
     resolution: {integrity: sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==}
 
@@ -1603,6 +1667,9 @@ packages:
   shell-quote@1.8.1:
     resolution: {integrity: sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==}
 
+  shellwords@0.1.1:
+    resolution: {integrity: sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww==}
+
   signal-exit@3.0.7:
     resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==}
 
@@ -1880,7 +1947,7 @@ snapshots:
       '@babel/traverse': 7.25.6
       '@babel/types': 7.25.6
       convert-source-map: 2.0.0
-      debug: 4.3.7
+      debug: 4.3.6
       gensync: 1.0.0-beta.2
       json5: 2.2.3
       semver: 6.3.1
@@ -2052,7 +2119,7 @@ snapshots:
       '@babel/parser': 7.25.6
       '@babel/template': 7.25.0
       '@babel/types': 7.25.6
-      debug: 4.3.7
+      debug: 4.3.6
       globals: 11.12.0
     transitivePeerDependencies:
       - supports-color
@@ -2068,7 +2135,7 @@ snapshots:
   '@eslint/eslintrc@0.4.3':
     dependencies:
       ajv: 6.12.6
-      debug: 4.3.7
+      debug: 4.3.6
       espree: 7.3.1
       globals: 13.24.0
       ignore: 4.0.6
@@ -2084,7 +2151,7 @@ snapshots:
   '@humanwhocodes/config-array@0.5.0':
     dependencies:
       '@humanwhocodes/object-schema': 1.2.1
-      debug: 4.3.7
+      debug: 4.3.6
       minimatch: 3.1.2
     transitivePeerDependencies:
       - supports-color
@@ -2110,10 +2177,10 @@ snapshots:
       jest-util: 29.7.0
       slash: 3.0.0
 
-  '@jest/core@29.7.0':
+  '@jest/core@29.7.0(node-notifier@8.0.2)':
     dependencies:
       '@jest/console': 29.7.0
-      '@jest/reporters': 29.7.0
+      '@jest/reporters': 29.7.0(node-notifier@8.0.2)
       '@jest/test-result': 29.7.0
       '@jest/transform': 29.7.0
       '@jest/types': 29.6.3
@@ -2140,6 +2207,8 @@ snapshots:
       pretty-format: 29.7.0
       slash: 3.0.0
       strip-ansi: 6.0.1
+    optionalDependencies:
+      node-notifier: 8.0.2
     transitivePeerDependencies:
       - babel-plugin-macros
       - supports-color
@@ -2185,7 +2254,7 @@ snapshots:
     transitivePeerDependencies:
       - supports-color
 
-  '@jest/reporters@29.7.0':
+  '@jest/reporters@29.7.0(node-notifier@8.0.2)':
     dependencies:
       '@bcoe/v8-coverage': 0.2.3
       '@jest/console': 29.7.0
@@ -2211,6 +2280,8 @@ snapshots:
       string-length: 4.0.2
       strip-ansi: 6.0.1
       v8-to-istanbul: 9.3.0
+    optionalDependencies:
+      node-notifier: 8.0.2
     transitivePeerDependencies:
       - supports-color
 
@@ -2380,58 +2451,58 @@ snapshots:
     dependencies:
       '@sinonjs/commons': 3.0.1
 
-  '@swc/core-darwin-arm64@1.7.26':
+  '@swc/core-darwin-arm64@1.7.23':
     optional: true
 
-  '@swc/core-darwin-x64@1.7.26':
+  '@swc/core-darwin-x64@1.7.23':
     optional: true
 
-  '@swc/core-linux-arm-gnueabihf@1.7.26':
+  '@swc/core-linux-arm-gnueabihf@1.7.23':
     optional: true
 
-  '@swc/core-linux-arm64-gnu@1.7.26':
+  '@swc/core-linux-arm64-gnu@1.7.23':
     optional: true
 
-  '@swc/core-linux-arm64-musl@1.7.26':
+  '@swc/core-linux-arm64-musl@1.7.23':
     optional: true
 
-  '@swc/core-linux-x64-gnu@1.7.26':
+  '@swc/core-linux-x64-gnu@1.7.23':
     optional: true
 
-  '@swc/core-linux-x64-musl@1.7.26':
+  '@swc/core-linux-x64-musl@1.7.23':
     optional: true
 
-  '@swc/core-win32-arm64-msvc@1.7.26':
+  '@swc/core-win32-arm64-msvc@1.7.23':
     optional: true
 
-  '@swc/core-win32-ia32-msvc@1.7.26':
+  '@swc/core-win32-ia32-msvc@1.7.23':
     optional: true
 
-  '@swc/core-win32-x64-msvc@1.7.26':
+  '@swc/core-win32-x64-msvc@1.7.23':
     optional: true
 
-  '@swc/core@1.7.26':
+  '@swc/core@1.7.23':
     dependencies:
       '@swc/counter': 0.1.3
       '@swc/types': 0.1.12
     optionalDependencies:
-      '@swc/core-darwin-arm64': 1.7.26
-      '@swc/core-darwin-x64': 1.7.26
-      '@swc/core-linux-arm-gnueabihf': 1.7.26
-      '@swc/core-linux-arm64-gnu': 1.7.26
-      '@swc/core-linux-arm64-musl': 1.7.26
-      '@swc/core-linux-x64-gnu': 1.7.26
-      '@swc/core-linux-x64-musl': 1.7.26
-      '@swc/core-win32-arm64-msvc': 1.7.26
-      '@swc/core-win32-ia32-msvc': 1.7.26
-      '@swc/core-win32-x64-msvc': 1.7.26
+      '@swc/core-darwin-arm64': 1.7.23
+      '@swc/core-darwin-x64': 1.7.23
+      '@swc/core-linux-arm-gnueabihf': 1.7.23
+      '@swc/core-linux-arm64-gnu': 1.7.23
+      '@swc/core-linux-arm64-musl': 1.7.23
+      '@swc/core-linux-x64-gnu': 1.7.23
+      '@swc/core-linux-x64-musl': 1.7.23
+      '@swc/core-win32-arm64-msvc': 1.7.23
+      '@swc/core-win32-ia32-msvc': 1.7.23
+      '@swc/core-win32-x64-msvc': 1.7.23
 
   '@swc/counter@0.1.3': {}
 
-  '@swc/jest@0.2.36(@swc/core@1.7.26)':
+  '@swc/jest@0.2.36(@swc/core@1.7.23)':
     dependencies:
       '@jest/create-cache-key-function': 29.7.0
-      '@swc/core': 1.7.26
+      '@swc/core': 1.7.23
       '@swc/counter': 0.1.3
       jsonc-parser: 3.3.1
 
@@ -2502,7 +2573,7 @@ snapshots:
       '@typescript-eslint/experimental-utils': 4.33.0(eslint@7.32.0)(typescript@4.9.5)
       '@typescript-eslint/parser': 4.33.0(eslint@7.32.0)(typescript@4.9.5)
       '@typescript-eslint/scope-manager': 4.33.0
-      debug: 4.3.7
+      debug: 4.3.6
       eslint: 7.32.0
       functional-red-black-tree: 1.0.1
       ignore: 5.3.2
@@ -2532,7 +2603,7 @@ snapshots:
       '@typescript-eslint/scope-manager': 4.33.0
       '@typescript-eslint/types': 4.33.0
       '@typescript-eslint/typescript-estree': 4.33.0(typescript@4.9.5)
-      debug: 4.3.7
+      debug: 4.3.6
       eslint: 7.32.0
     optionalDependencies:
       typescript: 4.9.5
@@ -2550,7 +2621,7 @@ snapshots:
     dependencies:
       '@typescript-eslint/types': 4.33.0
       '@typescript-eslint/visitor-keys': 4.33.0
-      debug: 4.3.7
+      debug: 4.3.6
       globby: 11.1.0
       is-glob: 4.0.3
       semver: 7.6.3
@@ -2688,8 +2759,8 @@ snapshots:
 
   browserslist@4.23.3:
     dependencies:
-      caniuse-lite: 1.0.30001660
-      electron-to-chromium: 1.5.23
+      caniuse-lite: 1.0.30001657
+      electron-to-chromium: 1.5.15
       node-releases: 2.0.18
       update-browserslist-db: 1.1.0(browserslist@4.23.3)
 
@@ -2709,7 +2780,7 @@ snapshots:
 
   camelcase@6.3.0: {}
 
-  caniuse-lite@1.0.30001660: {}
+  caniuse-lite@1.0.30001657: {}
 
   chalk@2.4.2:
     dependencies:
@@ -2728,7 +2799,7 @@ snapshots:
 
   ci-info@3.9.0: {}
 
-  cjs-module-lexer@1.4.1: {}
+  cjs-module-lexer@1.4.0: {}
 
   cliui@8.0.1:
     dependencies:
@@ -2793,9 +2864,9 @@ snapshots:
     dependencies:
       '@babel/runtime': 7.25.6
 
-  debug@4.3.7:
+  debug@4.3.6:
     dependencies:
-      ms: 2.1.3
+      ms: 2.1.2
 
   dedent@1.5.3: {}
 
@@ -2819,7 +2890,7 @@ snapshots:
     dependencies:
       esutils: 2.0.3
 
-  electron-to-chromium@1.5.23: {}
+  electron-to-chromium@1.5.15: {}
 
   emittery@0.13.1: {}
 
@@ -2868,7 +2939,7 @@ snapshots:
       ajv: 6.12.6
       chalk: 4.1.2
       cross-spawn: 7.0.3
-      debug: 4.3.7
+      debug: 4.3.6
       doctrine: 3.0.0
       enquirer: 2.4.1
       escape-string-regexp: 4.0.0
@@ -3041,6 +3112,9 @@ snapshots:
 
   graceful-fs@4.2.11: {}
 
+  growly@1.3.0:
+    optional: true
+
   has-flag@3.0.0: {}
 
   has-flag@4.0.0: {}
@@ -3086,6 +3160,9 @@ snapshots:
     dependencies:
       hasown: 2.0.2
 
+  is-docker@2.2.1:
+    optional: true
+
   is-extglob@2.1.1: {}
 
   is-fullwidth-code-point@3.0.0: {}
@@ -3102,6 +3179,11 @@ snapshots:
 
   is-stream@2.0.1: {}
 
+  is-wsl@2.2.0:
+    dependencies:
+      is-docker: 2.2.1
+    optional: true
+
   isexe@2.0.0: {}
 
   istanbul-lib-coverage@3.2.2: {}
@@ -3134,7 +3216,7 @@ snapshots:
 
   istanbul-lib-source-maps@4.0.1:
     dependencies:
-      debug: 4.3.7
+      debug: 4.3.6
       istanbul-lib-coverage: 3.2.2
       source-map: 0.6.1
     transitivePeerDependencies:
@@ -3177,9 +3259,9 @@ snapshots:
       - babel-plugin-macros
       - supports-color
 
-  jest-cli@29.7.0(@types/node@20.16.5):
+  jest-cli@29.7.0(@types/node@20.16.5)(node-notifier@8.0.2):
     dependencies:
-      '@jest/core': 29.7.0
+      '@jest/core': 29.7.0(node-notifier@8.0.2)
       '@jest/test-result': 29.7.0
       '@jest/types': 29.6.3
       chalk: 4.1.2
@@ -3190,6 +3272,8 @@ snapshots:
       jest-util: 29.7.0
       jest-validate: 29.7.0
       yargs: 17.7.2
+    optionalDependencies:
+      node-notifier: 8.0.2
     transitivePeerDependencies:
       - '@types/node'
       - babel-plugin-macros
@@ -3380,7 +3464,7 @@ snapshots:
       '@jest/types': 29.6.3
       '@types/node': 20.16.5
       chalk: 4.1.2
-      cjs-module-lexer: 1.4.1
+      cjs-module-lexer: 1.4.0
       collect-v8-coverage: 1.0.2
       glob: 7.2.3
       graceful-fs: 4.2.11
@@ -3466,12 +3550,14 @@ snapshots:
       merge-stream: 2.0.0
       supports-color: 8.1.1
 
-  jest@29.7.0(@types/node@20.16.5):
+  jest@29.7.0(@types/node@20.16.5)(node-notifier@8.0.2):
     dependencies:
-      '@jest/core': 29.7.0
+      '@jest/core': 29.7.0(node-notifier@8.0.2)
       '@jest/types': 29.6.3
       import-local: 3.2.0
-      jest-cli: 29.7.0(@types/node@20.16.5)
+      jest-cli: 29.7.0(@types/node@20.16.5)(node-notifier@8.0.2)
+    optionalDependencies:
+      node-notifier: 8.0.2
     transitivePeerDependencies:
       - '@types/node'
       - babel-plugin-macros
@@ -3557,7 +3643,7 @@ snapshots:
 
   mkdirp@1.0.4: {}
 
-  ms@2.1.3: {}
+  ms@2.1.2: {}
 
   natural-compare@1.4.0: {}
 
@@ -3567,6 +3653,16 @@ snapshots:
 
   node-int64@0.4.0: {}
 
+  node-notifier@8.0.2:
+    dependencies:
+      growly: 1.3.0
+      is-wsl: 2.2.0
+      semver: 7.6.3
+      shellwords: 0.1.1
+      uuid: 8.3.2
+      which: 2.0.2
+    optional: true
+
   node-releases@2.0.18: {}
 
   normalize-path@3.0.0: {}
@@ -3720,6 +3816,9 @@ snapshots:
 
   shell-quote@1.8.1: {}
 
+  shellwords@0.1.1:
+    optional: true
+
   signal-exit@3.0.7: {}
 
   sisteransi@1.0.5: {}
@@ -3810,12 +3909,12 @@ snapshots:
 
   tree-kill@1.2.2: {}
 
-  ts-jest@26.5.6(jest@29.7.0(@types/node@20.16.5))(typescript@4.9.5):
+  ts-jest@26.5.6(jest@29.7.0(@types/node@20.16.5)(node-notifier@8.0.2))(typescript@4.9.5):
     dependencies:
       bs-logger: 0.2.6
       buffer-from: 1.1.2
       fast-json-stable-stringify: 2.1.0
-      jest: 29.7.0(@types/node@20.16.5)
+      jest: 29.7.0(@types/node@20.16.5)(node-notifier@8.0.2)
       jest-util: 26.6.2
       json5: 2.2.3
       lodash: 4.17.21

.github/workflows/label-author.yml

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

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

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

.github/workflows/lock-issues.yml

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

.github/workflows/main.yml

@@ -2,25 +2,9 @@ name: build
 
 on:
   pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
+    types: [ opened, reopened, synchronize ]
   push:
-    branches:
-      - main
-      - beta
-
-concurrency:
-  # <workflow_name>-<branch_name>-<true || commit_sha if branch is protected>
-  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref_protected && github.sha || ''}}
-  cancel-in-progress: true
-
-env:
-  NODE_VERSION: 22.6.0
-  PNPM_VERSION: 9.7.1
-  DO_NOT_TRACK: 1 # Disable Turbopack telemetry
-  NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
+    branches: [ 'main' ]
 
 jobs:
   changes:
@@ -38,12 +22,12 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 25
-      - uses: dorny/paths-filter@v3
+      - uses: dorny/paths-filter@v2
         id: filter
         with:
           filters: |
             needs_build:
-              - '.github/workflows/**'
+              - '.github/workflows/main.yml'
               - 'packages/**'
               - 'test/**'
               - 'pnpm-lock.yaml'
@@ -55,52 +39,7 @@ jobs:
           echo "needs_build: ${{ steps.filter.outputs.needs_build }}"
           echo "templates: ${{ steps.filter.outputs.templates }}"
 
-  lint:
-    if: >
-      github.event_name == 'pull_request' && !contains(github.event.pull_request.title, 'no-lint') && !contains(github.event.pull_request.title, 'skip-lint')
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-      - name: Setup pnpm cache
-        uses: actions/cache@v4
-        timeout-minutes: 720
-        with:
-          path: ${{ env.STORE_PATH }}
-          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            pnpm-store-
-            pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-
-      - run: pnpm install
-      - name: Lint staged
-        run: |
-          git diff --name-only --diff-filter=d origin/${GITHUB_BASE_REF}...${GITHUB_SHA}
-          npx lint-staged --diff="origin/${GITHUB_BASE_REF}...${GITHUB_SHA}"
-
-  build:
+  core-build:
     needs: changes
     if: ${{ needs.changes.outputs.needs_build == 'true' }}
     runs-on: ubuntu-latest
@@ -114,15 +53,15 @@ jobs:
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 9.7.0
           run_install: false
 
       - name: Get pnpm store directory
@@ -130,73 +69,31 @@ jobs:
         run: |
           echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
 
-      - name: Setup pnpm cache
-        uses: actions/cache@v4
-        timeout-minutes: 720
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
         with:
           path: ${{ env.STORE_PATH }}
-          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
           restore-keys: |
-            pnpm-store-
-            pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+            ${{ runner.os }}-pnpm-store-
+            ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
 
       - run: pnpm install
-      - run: pnpm run build:all
-        env:
-          DO_NOT_TRACK: 1 # Disable Turbopack telemetry
+      - run: pnpm run build
 
       - name: Cache build
         uses: actions/cache@v4
-        timeout-minutes: 10
         with:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
 
-  tests-unit:
+  tests:
     runs-on: ubuntu-latest
-    needs: build
-
-    steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v4
-        timeout-minutes: 10
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Unit Tests
-        run: pnpm test:unit
-        env:
-          NODE_OPTIONS: --max-old-space-size=8096
-
-  tests-int:
-    runs-on: ubuntu-latest
-    needs: build
+    needs: core-build
     strategy:
       fail-fast: false
       matrix:
-        database:
-          - mongodb
-          - postgres
-          - postgres-custom-schema
-          - postgres-uuid
-          - supabase
-          - sqlite
+        database: [mongoose, postgres, postgres-custom-schema, postgres-uuid, supabase]
     env:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
@@ -207,25 +104,26 @@ jobs:
       AWS_REGION: us-east-1
 
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 25
       # https://github.com/actions/virtual-environments/issues/1187
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 9.7.0
           run_install: false
 
-      - run: pnpm install
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
 
       - name: Start LocalStack
         run: pnpm docker:start
@@ -233,7 +131,7 @@ jobs:
       - name: Start PostgreSQL
         uses: CasperWA/postgresql-action@v1.2
         with:
-          postgresql version: '14' # See https://hub.docker.com/_/postgres for available versions
+          postgresql version: '14'  # See https://hub.docker.com/_/postgres for available versions
           postgresql db: ${{ env.POSTGRES_DB }}
           postgresql user: ${{ env.POSTGRES_USER }}
           postgresql password: ${{ env.POSTGRES_PASSWORD }}
@@ -272,6 +170,9 @@ jobs:
           echo "POSTGRES_URL=postgresql://postgres:postgres@127.0.0.1:54322/postgres" >> $GITHUB_ENV
         if: matrix.database == 'supabase'
 
+      - name: Component Tests
+        run: pnpm test:components
+
       - name: Integration Tests
         run: pnpm test:int
         env:
@@ -281,183 +182,71 @@ jobs:
 
   tests-e2e:
     runs-on: ubuntu-latest
-    needs: build
+    needs: core-build
     strategy:
       fail-fast: false
       matrix:
-        # find test -type f -name 'e2e.spec.ts' | sort | xargs dirname | xargs -I {} basename {}
-        suite:
-          - _community
-          - access-control
-          - admin__e2e__1
-          - admin__e2e__2
-          - admin-root
-          - auth
-          - field-error-states
-          - fields-relationship
-          - fields
-          - fields__collections__Blocks
-          - fields__collections__Array
-          - fields__collections__Relationship
-          - fields__collections__RichText
-          - fields__collections__Lexical__e2e__main
-          - fields__collections__Lexical__e2e__blocks
-          - fields__collections__Date
-          - fields__collections__Number
-          - fields__collections__Point
-          - fields__collections__Tabs
-          - fields__collections__Text
-          - fields__collections__Upload
-          - live-preview
-          - localization
-          - locked-documents
-          - i18n
-          - plugin-cloud-storage
-          - plugin-form-builder
-          - plugin-nested-docs
-          - plugin-seo
-          - versions
-          - uploads
-    env:
-      SUITE_NAME: ${{ matrix.suite }}
+        part: [ 1/8, 2/8, 3/8, 4/8, 5/8, 6/8, 7/8, 8/8 ]
+
     steps:
       # https://github.com/actions/virtual-environments/issues/1187
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 9.7.0
           run_install: false
 
       - name: Restore build
         uses: actions/cache@v4
-        timeout-minutes: 10
         with:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
 
-      - name: Start LocalStack
-        run: pnpm docker:start
-        if: ${{ matrix.suite == 'plugin-cloud-storage' }}
-
-      - name: Store Playwright's Version
-        run: |
-          # Extract the version number using a more targeted regex pattern with awk
-          PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --depth=0 | awk '/@playwright\/test/ {print $2}')
-          echo "Playwright's Version: $PLAYWRIGHT_VERSION"
-          echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
-
-      - name: Cache Playwright Browsers for Playwright's Version
-        id: cache-playwright-browsers
-        uses: actions/cache@v4
-        with:
-          path: ~/.cache/ms-playwright
-          key: playwright-browsers-${{ env.PLAYWRIGHT_VERSION }}
-
-      - name: Setup Playwright - Browsers and Dependencies
-        if: steps.cache-playwright-browsers.outputs.cache-hit != 'true'
-        run: pnpm exec playwright install --with-deps chromium
-
-      - name: Setup Playwright - Dependencies-only
-        if: steps.cache-playwright-browsers.outputs.cache-hit == 'true'
-        run: pnpm exec playwright install-deps chromium
-
       - name: E2E Tests
-        run: PLAYWRIGHT_JSON_OUTPUT_NAME=results_${{ matrix.suite }}.json pnpm test:e2e:prod:ci ${{ matrix.suite }}
-        env:
-          PLAYWRIGHT_JSON_OUTPUT_NAME: results_${{ matrix.suite }}.json
-          NEXT_TELEMETRY_DISABLED: 1
+        uses: nick-fields/retry@v2
+        with:
+          retry_on: error
+          max_attempts: 2
+          timeout_minutes: 15
+          command: pnpm test:e2e --part ${{ matrix.part }} --bail
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v3
         if: always()
         with:
-          name: test-results-${{ matrix.suite }}
-          path: test/test-results/
-          if-no-files-found: ignore
+          name: test-results
+          path: test-results/
           retention-days: 1
 
-      # Disabled until this is fixed: https://github.com/daun/playwright-report-summary/issues/156
-      # - uses: daun/playwright-report-summary@v3
-      #   with:
-      #     report-file: results_${{ matrix.suite }}.json
-      #     report-tag: ${{ matrix.suite }}
-      #     job-summary: true
-
-  app-build-with-packed:
-    if: false # Disable until package resolution in tgzs can be figured out
-    runs-on: ubuntu-latest
-    needs: build
-
-    steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v4
-        timeout-minutes: 10
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.11.0
-        with:
-          mongodb-version: 6.0
-
-      - name: Pack and build app
-        run: |
-          set -ex
-          pnpm run script:pack --dest templates/blank
-          cd templates/blank
-          cp .env.example .env
-          ls -la
-          pnpm add ./*.tgz --ignore-workspace
-          pnpm install --ignore-workspace --no-frozen-lockfile
-          cat package.json
-          pnpm run build
-
   tests-type-generation:
     runs-on: ubuntu-latest
-    needs: build
+    needs: core-build
 
     steps:
       # https://github.com/actions/virtual-environments/issues/1187
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 9.7.0
           run_install: false
 
       - name: Restore build
         uses: actions/cache@v4
-        timeout-minutes: 10
         with:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
@@ -468,30 +257,117 @@ jobs:
       - name: Generate GraphQL schema file
         run: pnpm dev:generate-graphql-schema graphql-schema-gen
 
+  build-packages:
+    runs-on: ubuntu-latest
+    needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg:
+          - db-mongodb
+          - db-postgres
+          - bundler-webpack
+          - bundler-vite
+          - richtext-slate
+          - richtext-lexical
+          - live-preview
+          - live-preview-react
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 9.7.0
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Build ${{ matrix.pkg }}
+        run: pnpm turbo run build --filter=${{ matrix.pkg }}
+
+  plugins:
+    runs-on: ubuntu-latest
+    needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg:
+          - create-payload-app
+          - plugin-cloud
+          - plugin-cloud-storage
+          - plugin-form-builder
+          - plugin-nested-docs
+          - plugin-search
+          - plugin-sentry
+          - plugin-seo
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 9.7.0
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Build ${{ matrix.pkg }}
+        run: pnpm turbo run build --filter=${{ matrix.pkg }}
+
+      - name: Test ${{ matrix.pkg }}
+        run: pnpm --filter ${{ matrix.pkg }} run test
+        if: matrix.pkg != 'create-payload-app' # degit doesn't work within GitHub Actions
+
   templates:
     needs: changes
-    if: false # Disable until templates are updated for 3.0
+    if: ${{ needs.changes.outputs.templates == 'true' }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        template: [blank, website, ecommerce]
+        template: [ blank, website, ecommerce ]
 
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 25
+
       # https://github.com/actions/virtual-environments/issues/1187
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.11.0
+        uses: supercharge/mongodb-github-action@1.10.0
         with:
           mongodb-version: 6.0
 
@@ -502,62 +378,3 @@ jobs:
           yarn install
           yarn build
           yarn generate:types
-
-  generated-templates:
-    needs: build
-    if: false # Needs to pull in tgz files from build
-    runs-on: ubuntu-latest
-
-    steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v4
-        timeout-minutes: 10
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build all generated templates
-        run: pnpm tsx ./scripts/build-generated-templates.ts
-
-  all-green:
-    name: All Green
-    if: always()
-    runs-on: ubuntu-latest
-    needs:
-      - lint
-      - build
-      - tests-unit
-      - tests-int
-      - tests-e2e
-
-    steps:
-      - if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
-        run: exit 1
-
-  publish-canary:
-    name: Publish Canary
-    runs-on: ubuntu-latest
-    needs:
-      - all-green
-
-    steps:
-      # debug github.ref output
-      - run: |
-          echo github.ref: ${{ github.ref }}
-          echo isBeta: ${{ github.ref == 'refs/heads/beta' }}
-          echo isMain: ${{ github.ref == 'refs/heads/main' }}

.github/workflows/post-release.yml

@@ -15,6 +15,7 @@ jobs:
           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:
@@ -23,6 +24,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           tag-filter: 'v\d'
 
+
           # Change to blank to disable commenting
           # comment-template: ''
 

.github/workflows/pr-title.yml

@@ -1,121 +0,0 @@
-name: pr-title
-
-on:
-  pull_request:
-    types:
-      - opened
-      - edited
-      - synchronize
-
-permissions:
-  pull-requests: write
-
-jobs:
-  main:
-    name: lint-pr-title
-    runs-on: ubuntu-latest
-    steps:
-      - uses: amannn/action-semantic-pull-request@v5
-        id: lint_pr_title
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          types: |
-            build
-            chore
-            ci
-            docs
-            feat
-            fix
-            perf
-            refactor
-            revert
-            style
-            test
-            types
-          scopes: |
-            cpa
-            db-\*
-            db-mongodb
-            db-postgres
-            db-vercel-postgres
-            db-sqlite
-            drizzle
-            email-nodemailer
-            eslint
-            graphql
-            live-preview
-            live-preview-react
-            next
-            plugin-cloud
-            plugin-cloud-storage
-            plugin-form-builder
-            plugin-nested-docs
-            plugin-redirects
-            plugin-search
-            plugin-sentry
-            plugin-seo
-            plugin-stripe
-            richtext-\*
-            richtext-lexical
-            richtext-slate
-            storage-\*
-            storage-azure
-            storage-gcs
-            storage-uploadthing
-            storage-vercel-blob
-            storage-s3
-            translations
-            ui
-            templates
-            examples(\/(\w|-)+)?
-            deps
-
-          # Disallow uppercase letters at the beginning of the subject
-          subjectPattern: ^(?![A-Z]).+$
-          subjectPatternError: |
-            The subject "{subject}" found in the pull request title "{title}"
-            didn't match the configured pattern. Please ensure that the subject
-            doesn't start with an uppercase character.
-
-      - uses: marocchino/sticky-pull-request-comment@v2
-        # When the previous steps fails, the workflow would stop. By adding this
-        # condition you can continue the execution with the populated error message.
-        if: always() && (steps.lint_pr_title.outputs.error_message != null)
-        with:
-          header: pr-title-lint-error
-          message: |
-            Pull Request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and have valid scopes.
-
-            ${{ steps.lint_pr_title.outputs.error_message }}
-
-            ```
-            feat(ui): add Button component
-            ^    ^    ^
-            |    |    |__ Subject
-            |    |_______ Scope
-            |____________ Type
-            ```
-
-      # Delete a previous comment when the issue has been resolved
-      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
-        uses: marocchino/sticky-pull-request-comment@v2
-        with:
-          header: pr-title-lint-error
-          delete: true
-
-  label-pr-on-open:
-    name: label-pr-on-open
-    runs-on: ubuntu-latest
-    if: github.event.action == 'opened'
-    steps:
-      - name: Tag with main branch with v2
-        if: github.event.pull_request.base.ref == 'main'
-        uses: actions-ecosystem/action-add-labels@v1
-        with:
-          labels: v2
-      - name: Tag with beta branch with v3
-        if: github.event.pull_request.base.ref == 'beta'
-        uses: actions-ecosystem/action-add-labels@v1
-        with:
-          labels: v3

.github/workflows/release-canary.yml

@@ -2,35 +2,10 @@ name: release-canary
 
 on:
   workflow_dispatch:
-    branches:
-      - beta
-
-env:
-  NODE_VERSION: 22.6.0
-  PNPM_VERSION: 9.7.1
-  DO_NOT_TRACK: 1 # Disable Turbopack telemetry
-  NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
 
 jobs:
-  release:
-    permissions:
-      id-token: write
+  test:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup
-        uses: ./.github/actions/setup
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-          pnpm-version: ${{ env.PNPM_VERSION }}
-      - name: Load npm token
-        run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: Canary release script
-        # dry run hard-coded to true for testing and no npm token provided
-        run: pnpm tsx ./scripts/publish-canary.ts
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          NPM_CONFIG_PROVENANCE: true
+      - name: Echo
+        run: echo "Register release-canary workflow"

.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

@@ -3,34 +3,15 @@ package-lock.json
 dist
 /.idea/*
 !/.idea/runConfigurations
-!/.idea/payload.iml
 
 # Custom actions
 !.github/actions/**/dist
 
-test/packed
 test-results
 .devcontainer
 .localstack
 /migrations
 .localstack
-.turbo
-
-meta_client.json
-meta_server.json
-meta_index.json
-meta_shared.json
-
-.turbo
-
-# Ignore test directory media folder/files
-/media
-test/media
-*payloadtests.db
-*payloadtests.db-journal
-*payloadtests.db-shm
-*payloadtests.db-wal
-/versions
 
 # Created by https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=node,macos,windows,webstorm,sublimetext,visualstudiocode
@@ -156,8 +137,6 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
-dist
-dist_optimized
 
 # Gatsby files
 .cache/
@@ -304,16 +283,3 @@ $RECYCLE.BIN/
 # End of https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
 
 /build
-.swc
-app/(payload)/admin/importMap.js
-test/live-preview/app/(payload)/admin/importMap.js
-/test/live-preview/app/(payload)/admin/importMap.js
-test/admin-root/app/(payload)/admin/importMap.js
-/test/admin-root/app/(payload)/admin/importMap.js
-test/app/(payload)/admin/importMap.js
-/test/app/(payload)/admin/importMap.js
-test/pnpm-lock.yaml
-test/databaseAdapter.js
-/filename-compound-index
-/media-with-relation-preview
-/media-without-relation-preview

.husky/pre-commit

@@ -1 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
 pnpm run lint-staged --quiet

.idea/payload.iml

@@ -1,87 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/components" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/examples" />
-      <excludeFolder url="file://$MODULE_DIR$/media" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/create-payload-app/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/create-payload-app/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-mongodb/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-mongodb/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-postgres/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-postgres/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/graphql/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/graphql/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-react/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-react/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/next/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/next/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/next/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/fields" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud-storage/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud-storage/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-form-builder/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-nested-docs/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-nested-docs/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-redirects/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-redirects/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-search/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-search/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-sentry/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-seo/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-seo/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-stripe/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-lexical/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-lexical/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/templates" />
-      <excludeFolder url="file://$MODULE_DIR$/test/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/versions" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-slate/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-slate/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-nodemailer/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-nodemailer/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-resend/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-resend/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-vue/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-vue/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-form-builder/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-relationship-object-ids/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-relationship-object-ids/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-stripe/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-azure/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-azure/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-gcs/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-gcs/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-s3/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-s3/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-uploadthing/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-uploadthing/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-vercel-blob/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-vercel-blob/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/translations/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/translations/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/ui/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/ui/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/ui/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/drizzle/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/drizzle/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/dist" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

.idea/runConfigurations/Run_Dev_Fields.xml

@@ -1,13 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev Fields" type="js.build_tools.npm">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="dev" />
-    </scripts>
-    <arguments value="fields" />
-    <node-interpreter value="project" />
-    <envs />
+  <configuration default="false" name="Run Dev Fields" type="NodeJSConfigurationType" application-parameters="fields" path-to-js-file="node_modules/.pnpm/nodemon@3.0.3/node_modules/nodemon/bin/nodemon.js" working-dir="$PROJECT_DIR$">
     <method v="2" />
   </configuration>
 </component>

.idea/runConfigurations/Run_Dev__community.xml

@@ -1,13 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev _community" type="js.build_tools.npm">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="dev" />
-    </scripts>
-    <arguments value="_community" />
-    <node-interpreter value="project" />
-    <envs />
+  <configuration default="false" name="Run Dev _community" type="NodeJSConfigurationType" application-parameters="_community" path-to-js-file="node_modules/.pnpm/nodemon@3.0.3/node_modules/nodemon/bin/nodemon.js" working-dir="$PROJECT_DIR$">
     <method v="2" />
   </configuration>
 </component>

.idea/runConfigurations/Run_Dev_admin.xml

@@ -1,13 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev admin" type="js.build_tools.npm">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="dev" />
-    </scripts>
-    <arguments value="admin" />
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

.idea/runConfigurations/_template__of_JavaScriptTestRunnerJest.xml

@@ -1,9 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="true" type="JavaScriptTestRunnerJest">
-    <node-interpreter value="project" />
-    <node-options value="--no-deprecation" />
-    <envs />
-    <scope-kind value="ALL" />
-    <method v="2" />
-  </configuration>
-</component>

.node-version

@@ -1 +1 @@
-v22.6.0
+v18.17.1

.npmrc

@@ -1,3 +1,2 @@
 symlink=true
-node-linker=isolated
-hoist-workspace-packages=false # the default in pnpm v9 is true, but that can break our runtime dependency checks
+node-linker=isolated # due to a typescript bug, isolated mode requires @types/express-serve-static-core, terser and monaco-editor to be installed https://github.com/microsoft/TypeScript/issues/47663#issuecomment-1519138189 along with two other changes in the code which I've marked with (tsbugisolatedmode) in the code

.nvmrc

@@ -1 +1 @@
-v22.6.0
+v18.17.1

.prettierignore

@@ -9,8 +9,3 @@
 **/node_modules
 **/temp
 **/docs/**
-tsconfig.json
-packages/payload/*.js
-packages/payload/*.d.ts
-payload-types.ts
-tsconfig.tsbuildinfo

.release-it.pre.js

@@ -0,0 +1,16 @@
+module.exports = {
+  verbose: true,
+  git: {
+    requireCleanWorkingDir: false,
+    commit: false,
+    push: false,
+    tag: false,
+  },
+  npm: {
+    skipChecks: true,
+    tag: 'beta',
+  },
+  hooks: {
+    'before:init': ['pnpm install', 'pnpm clean', 'pnpm build'],
+  },
+}

.swcrc

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

.tool-versions

@@ -1,2 +0,0 @@
-pnpm 9.7.1
-nodejs 22.6.0

.vscode/extensions.json

@@ -1,8 +1,3 @@
 {
-  "recommendations": [
-    "dbaeumer.vscode-eslint",
-    "esbenp.prettier-vscode",
-    "firsttris.vscode-jest-runner",
-    "ms-playwright.playwright"
-  ]
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
 }

.vscode/launch.json

@@ -3,73 +3,12 @@
   // Hover to view descriptions of existing attributes.
   "configurations": [
     {
-      "command": "pnpm generate:types",
-      "name": "Generate Types CLI",
-      "request": "launch",
-      "type": "node-terminal",
-      "cwd": "${workspaceFolder}"
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts _community",
+      "command": "pnpm run dev _community",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Community",
       "request": "launch",
       "type": "node-terminal"
     },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts storage-uploadthing",
-      "cwd": "${workspaceFolder}",
-      "name": "Uploadthing",
-      "request": "launch",
-      "type": "node-terminal",
-      "envFile": "${workspaceFolder}/test/storage-uploadthing/.env"
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts live-preview",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Live Preview",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "node --no-deprecation test/loader/init.js",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Loader",
-      "request": "launch",
-      "type": "node-terminal",
-      "env": {
-        "LOADER_TEST_FILE_PATH": "./dependency-test.js"
-        // "LOADER_TEST_FILE_PATH": "../fields/config.ts"
-      }
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts admin",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Admin",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts auth",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Auth",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts fields-relationship",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Fields-Relationship",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts login-with-username",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Login-With-Username",
-      "request": "launch",
-      "type": "node-terminal"
-    },
     {
       "command": "pnpm run dev plugin-cloud-storage",
       "cwd": "${workspaceFolder}",
@@ -81,63 +20,63 @@
       }
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts collections-graphql",
+      "command": "pnpm run dev collections-graphql",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev GraphQL",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts fields",
+      "command": "pnpm run dev fields",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Fields",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts versions",
+      "command": "pnpm run dev:postgres fields",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Postgres",
       "request": "launch",
-      "type": "node-terminal",
-      "env": {
-        "PAYLOAD_DATABASE": "postgres"
-      }
+      "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts versions",
+      "command": "pnpm run dev versions",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Versions",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts localization",
+      "command": "pnpm run dev localization",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Localization",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts locked-documents",
+      "command": "pnpm run dev field-error-states",
       "cwd": "${workspaceFolder}",
-      "name": "Run Dev Locked Documents",
+      "name": "Run Dev Field Error States",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts uploads",
+      "command": "pnpm run dev uploads",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Uploads",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts field-error-states",
+      "command": "PAYLOAD_BUNDLER=vite pnpm run dev fields",
       "cwd": "${workspaceFolder}",
-      "name": "Run Dev Field Error States",
+      "name": "Run Dev Fields (Vite)",
       "request": "launch",
-      "type": "node-terminal"
+      "type": "node-terminal",
+      "env": {
+        "NODE_ENV": "production"
+      }
     },
     {
       "command": "pnpm run test:int live-preview",
@@ -177,6 +116,17 @@
       "request": "launch",
       "type": "node-terminal"
     },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts generate:types",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/_community/config.ts",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+      },
+      "name": "Generate Types CLI",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
     {
       "command": "ts-node ./packages/payload/src/bin/index.ts migrate:status",
       "env": {

.vscode/settings.json

@@ -31,26 +31,13 @@
     "editor.formatOnSave": true
   },
   "editor.formatOnSaveMode": "file",
-  "eslint.rules.customizations": [
-    // Defaultt all ESLint errors to 'warn' to differentate from TypeScript's 'error' level
-    { "rule": "*", "severity": "warn" },
-
-    // Silence some warnings that will get auto-fixed
-    { "rule": "perfectionist/*", "severity": "off", "fixable": true },
-    { "rule": "curly", "severity": "off", "fixable": true },
-    { "rule": "object-shorthand", "severity": "off", "fixable": true }
-  ],
+  // All ESLint rules to 'warn' to differentate from TypeScript's 'error' level
+  "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"],
-  "[javascript][typescript][typescriptreact]": {
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": "explicit"
-    }
-  },
-  "files.insertFinalNewline": true,
-  "jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--no-deprecation\" node 'node_modules/jest/bin/jest.js'",
+  "jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--experimental-vm-modules --no-deprecation\" node 'node_modules/jest/bin/jest.js'",
   "jestrunner.debugOptions": {
-    "runtimeArgs": ["--no-deprecation"]
+    "runtimeArgs": ["--experimental-vm-modules", "--no-deprecation"]
   }
 }

CONTRIBUTING.md

@@ -63,7 +63,7 @@ Each test directory is split up in this way specifically to reduce friction when
 
 The following command will start Payload with your config: `pnpm dev my-test-dir`. Example: `pnpm dev fields` for the test/`fields` test suite. This command will start up Payload using your config and refresh a test database on every restart. If you're using VS Code, the most common run configs are automatically added to your editor - you should be able to find them in your VS Code launch tab.
 
-By default, payload will [automatically log you in](https://payloadcms.com/docs/authentication/overview#admin-autologin) with the default credentials. To disable that, you can either pass in the --no-auto-login flag (example: `pnpm dev my-test-dir --no-auto-login`) or set the `PAYLOAD_PUBLIC_DISABLE_AUTO_LOGIN` environment variable to `false`.
+By default, payload will [automatically log you in](https://payloadcms.com/docs/authentication/config#admin-autologin) with the default credentials. To disable that, you can either pass in the --no-auto-login flag (example: `pnpm dev my-test-dir --no-auto-login`) or set the `PAYLOAD_PUBLIC_DISABLE_AUTO_LOGIN` environment variable to `false`.
 
 The default credentials are `dev@payloadcms.com` as E-Mail and `test` as password. These are used in the auto-login.
 
@@ -120,21 +120,5 @@ This is how you can preview changes you made locally to the docs:
 2. Run `yarn install`
 3. Duplicate the `.env.example` file and rename it to `.env`
 4. Add a `DOCS_DIR` environment variable to the `.env` file which points to the absolute path of your modified docs folder. For example `DOCS_DIR=/Users/yourname/Documents/GitHub/payload/docs`
-5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
+5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: *Docs successfully written to /.../website/src/app/docs.json*. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
 6. You're done! Now you can start the website locally using `yarn run dev` and preview the docs under [http://localhost:3000/docs/](http://localhost:3000/docs/)
-
-## Internationalization (i18n)
-
-If your PR adds a string to the UI, we need to make sure to translate it into all the languages ​​that Payload supports. To do that:
-
-- Find the appropriate internationalization file for your package. These are typically located in `packages/translations/src/languages`, although some packages (e.g., richtext-lexical) have separate i18n files for each feature.
-- Add the string to the English locale "en".
-- Translate it to other languages. You can use the `translateNewKeys` script if you have an OpenAI API key in your `.env` (under `OPENAI_KEY`), or you can use ChatGPT or Google translate - whatever is easier for you. For payload core translations (in packages/translations) you can run the `translateNewKeys` script using `cd packages/translations && pnpm translateNewKeys`. For lexical translations, you can run it using `cd packages/richtext-lexical && pnpm translateNewKeys`. External contributors can skip this step and leave it to us.
-
-To display translation strings in the UI, make sure to use the `t` utility of the `useTranslation` hook:
-
-```ts
-const { t } = useTranslation()
-// ...
-t('yourStringKey')
-```

README.md

@@ -1,7 +1,6 @@
 <a href="https://payloadcms.com"><img width="100%" src="https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/assets/images/github-banner-alt.jpg?raw=true" alt="Payload headless CMS Admin panel built with React" /></a>
 <br />
 <br />
-
 <p align="left">
   <a href="https://github.com/payloadcms/payload/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/payloadcms/payload/main.yml?style=flat-square"></a>
   &nbsp;
@@ -18,7 +17,7 @@
 <hr/>
 
 > [!IMPORTANT]
-> 🎉 <strong>Payload 2.0 is now available!</strong> Read more in the <a target="_blank" href="https://payloadcms.com/blog/payload-2-0" rel="dofollow"><strong>announcement post</strong></a>.
+> 🎉 <strong>Payload 3.0 beta released!</strong> You can now deploy Payload fully in any Next.js app folder. Read more in the <a target="_blank" href="https://payloadcms.com/blog/30-beta-install-payload-into-any-nextjs-app-with-one-line" rel="dofollow"><strong>announcement post</strong></a>.
 
 <h3>Benefits over a regular CMS</h3>
 <ul>

app/(app)/layout.tsx

@@ -1,14 +0,0 @@
-import React from 'react'
-
-export const metadata = {
-  description: 'Generated by Next.js',
-  title: 'Next.js',
-}
-
-export default function RootLayout({ children }: { children: React.ReactNode }) {
-  return (
-    <html lang="en">
-      <body>{children}</body>
-    </html>
-  )
-}

app/(app)/test/page.tsx

@@ -1,11 +0,0 @@
-import configPromise from '@payload-config'
-import { getPayloadHMR } from '@payloadcms/next/utilities'
-
-export const Page = async ({ params, searchParams }) => {
-  const payload = await getPayloadHMR({
-    config: configPromise,
-  })
-  return <div>test ${payload?.config?.collections?.length}</div>
-}
-
-export default Page

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

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

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

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

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

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

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

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

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

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

app/(payload)/layout.tsx

@@ -1,21 +0,0 @@
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
-import configPromise from '@payload-config'
-import { RootLayout } from '@payloadcms/next/layouts'
-// import '@payloadcms/ui/styles.css' // Uncomment this line if `@payloadcms/ui` in `tsconfig.json` points to `/ui/dist` instead of `/ui/src`
-import React from 'react'
-
-import { importMap } from './admin/importMap.js'
-import './custom.scss'
-
-type Args = {
-  children: React.ReactNode
-}
-
-const Layout = ({ children }: Args) => (
-  <RootLayout config={configPromise} importMap={importMap}>
-    {children}
-  </RootLayout>
-)
-
-export default Layout

app/global-error.tsx

@@ -1,27 +0,0 @@
-/* eslint-disable no-restricted-exports */
-'use client'
-
-import * as Sentry from '@sentry/nextjs'
-import NextError from 'next/error.js'
-import { useEffect } from 'react'
-
-export default function GlobalError({ error }: { error: { digest?: string } & Error }) {
-  useEffect(() => {
-    if (process.env.NEXT_PUBLIC_SENTRY_DSN) {
-      Sentry.captureException(error)
-    }
-  }, [error])
-
-  return (
-    <html lang="en-US">
-      <body>
-        {/* `NextError` is the default Next.js error page component. Its type
-        definition requires a `statusCode` prop. However, since the App Router
-        does not expose status codes for errors, we simply pass 0 to render a
-        generic error message. */}
-        {/* @ts-expect-error types repo */}
-        <NextError statusCode={0} />
-      </body>
-    </html>
-  )
-}

app/my-route/route.ts

@@ -1,5 +0,0 @@
-export const GET = () => {
-  return Response.json({
-    hello: 'elliot',
-  })
-}

changelog.config.js

@@ -0,0 +1,39 @@
+module.exports = {
+  // gitRawCommitsOpts: {
+  //   from: 'v2.0.9',
+  //   path: 'packages/payload',
+  // },
+  // infile: 'CHANGELOG.md',
+  options: {
+    preset: {
+      name: 'conventionalcommits',
+      types: [
+        { section: 'Features', type: 'feat' },
+        { section: 'Features', type: 'feature' },
+        { section: 'Bug Fixes', type: 'fix' },
+        { section: 'Documentation', type: 'docs' },
+      ],
+    },
+  },
+  // outfile: 'NEW.md',
+  writerOpts: {
+    commitGroupsSort: (a, b) => {
+      const groupOrder = ['Features', 'Bug Fixes', 'Documentation']
+      return groupOrder.indexOf(a.title) - groupOrder.indexOf(b.title)
+    },
+
+    // Scoped commits at the end, alphabetical sort
+    commitsSort: (a, b) => {
+      if (a.scope || b.scope) {
+        if (!a.scope) return -1
+        if (!b.scope) return 1
+        return a.scope === b.scope
+          ? a.subject.localeCompare(b.subject)
+          : a.scope.localeCompare(b.scope)
+      }
+
+      // Alphabetical sort
+      return a.subject.localeCompare(b.subject)
+    },
+  },
+}

docs/access-control/collections.mdx

@@ -1,339 +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, nextjs
----
-
-Collection Access Control is [Access Control](../access-control) used to restrict access to Documents within a [Collection](../collections/overview), as well as what they can and cannot see within the [Admin Panel](../admin/overview) as it relates to that Collection.
-
-To add Access Control to a Collection, use the `access` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload';
-
-export const CollectionWithAccessControl: CollectionConfig = {
-  // ...
-  access: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Config Options
-
-Access Control is specific to the operation of the request.
-
-To add Access Control to a Collection, use the `access` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload';
-
-export const CollectionWithAccessControl: CollectionConfig = {
-  // ...
-  // highlight-start
-  access: {
-    create: () => {...},
-    read: () => {...},
-    update: () => {...},
-    delete: () => {...},
-
-    // Auth-enabled Collections only
-    admin: () => {...},
-    unlock: () => {...},
-
-    // Version-enabled Collections only
-    readVersions: () => {...},
-  },
-  // highlight-end
-}
-```
-
-The following options are available:
-
-| Function                | Allows/Denies Access                         |
-| ----------------------- | -------------------------------------------- |
-| **`create`** | Used in the `create` operation. [More details](#create). |
-| **`read`**     | Used in the `find` and `findByID` operations. [More details](#read). |
-| **`update`** | Used in the `update` operation. [More details](#update). |
-| **`delete`** | Used in the `delete` operation. [More details](#delete). |
-
-If a Collection supports [`Authentication`](../authentication/overview), the following additional options are available:
-
-| Function                | Allows/Denies Access                                           |
-| ----------------------- | -------------------------------------------------------------- |
-| **`admin`**   | Used to restrict access to the [Admin Panel](../admin/overview). [More details](#admin). |
-| **`unlock`** | Used to restrict which users can access the `unlock` operation. [More details](#unlock). |
-
-If a Collection supports [Versions](../versions/overview), the following additional options are available:
-
-| Function           | Allows/Denies Access                                                                                                   |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| **`readVersions`** | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. [More details](#read-versions). |
-
-### Create
-
-Returns a boolean which allows/denies access to the `create` request.
-
-To add create Access Control to a Collection, use the `create` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithCreateAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    create: ({ req: { user }, data }) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `create` function:
-
-| Option     | Description                                                                                                                  |
-| ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-| **`data`** | The data passed to create the document with.                                                                                 |
-
-### Read
-
-Returns a boolean which allows/denies access to the `read` request.
-
-To add read Access Control to a Collection, use the `read` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithReadAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    read: ({ req: { user } }) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  Return a [Query](../queries/overview) to limit the Documents to only those that match the constraint. This can be helpful to restrict users' access to specific Documents. [More details](../queries/overview).
-</Banner>
-
-As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
-
-```ts
-import type { Access } from 'payload'
-
-export const canReadPage: Access = ({ req: { user } }) => {
-  // Allow authenticated users
-  if (user) {
-    return true
-  }
-
-  // By returning a Query, guest users can read public Documents
-  // Note: this assumes you have a `isPublic` checkbox field on your Collection
-  return {
-    isPublic: {
-      equals: true,
-    },
-  }
-}
-```
-
-The following arguments are provided to the `read` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-| **`id`**  | `id` of document requested, if within `findByID`.                           |
-
-### Update
-
-Returns a boolean which allows/denies access to the `update` request.
-
-To add update Access Control to a Collection, use the `update` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithUpdateAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    update: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  Return a [Query](../queries/overview) to limit the Documents to only those that match the constraint. This can be helpful to restrict users' access to specific Documents. [More details](../queries/overview).
-</Banner>
-
-As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
-
-```ts
-import type { Access } from 'payload'
-
-export 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
-}
-```
-
-The following arguments are provided to the `update` function:
-
-| Option     | Description                                                                |
-| ---------- | -------------------------------------------------------------------------- |
-| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-| **`id`**   | `id` of document requested to update.                                       |
-| **`data`** | The data passed to update the document with.                                |
-
-### 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.
-
-To add delete Access Control to a Collection, use the `delete` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithDeleteAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    delete: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
-
-```ts
-import type { Access } from 'payload'
-
-export 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
-}
-```
-
-The following arguments are provided to the `delete` function:
-
-| Option    | Description                                                                                         |
-| --------- | --------------------------------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object with additional `user` property, which is the currently logged in user. |
-| **`id`**  | `id` of document requested to delete.
-
-### Admin
-
-If the Collection is use to access the [Admin Panel](../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.
-
-To add Admin Access Control to a Collection, use the `admin` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithAdminAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    admin: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `admin` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/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/overview#options).
-
-To add Unlock Access Control to a Collection, use the `unlock` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithUnlockAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    unlock: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `unlock` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-
-### Read Versions
-
-If the Collection has [Versions](../versions/overview) enabled, the `readVersions` Access Control function determines whether or not the currently logged in user can access the version history of a Document.
-
-To add Read Versions Access Control to a Collection, use the `readVersions` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithVersionsAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    readVersions: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `readVersions` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |

docs/access-control/fields.mdx

@@ -1,103 +0,0 @@
----
-title: Field-level Access Control
-label: Fields
-order: 40
-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, nextjs
----
-
-Field Access Control is [Access Control](../access-control) used to restrict access to specific [Fields](../fields/overview) within a Document.
-
-To add Access Control to a Field, use the `access` property in your [Field Config](../fields/overview):
-
-```ts
-import type { Field } from 'payload';
-
-export const FieldWithAccessControl: Field = {
-  // ...
-  access: { // highlight-line
-    // ...
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  Field Access Controls does not support returning [Query](../queries/overview) constraints like [Collection Access Control](./collections) does.
-</Banner>
-
-## Config Options
-
-Access Control is specific to the operation of the request.
-
-To add Access Control to a Field, use the `access` property in the [Field Config](../fields/overview):
-
-```ts
-import type { CollectionConfig } from 'payload';
-
-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
-    };
-  ],
-};
-```
-
-The following options are available:
-
-| Function                | Purpose                                                                          |
-| ----------------------- | -------------------------------------------------------------------------------- |
-| **`create`** | Allows or denies the ability to set a field's value when creating a new document. [More details](#create). |
-| **`read`**     | Allows or denies the ability to read a field's value. [More details](#read).       |
-| **`update`** | Allows or denies the ability to update a field's value [More details](#update).    |
-
-### 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 [Request](https://developer.mozilla.org/en-US/docs/Web/API/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 [Request](https://developer.mozilla.org/en-US/docs/Web/API/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 [Request](https://developer.mozilla.org/en-US/docs/Web/API/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,142 +0,0 @@
----
-title: Globals Access Control
-label: Globals
-order: 30
-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, nextjs
----
-
-Global Access Control is [Access Control](../access-control) used to restrict access to [Global](../globals/overview) Documents, as well as what they can and cannot see within the [Admin Panel](../admin/overview) as it relates to that Global.
-
-To add Access Control to a Global, use the `access` property in your [Global Config](../configuration/globals):
-
-```ts
-import type { GlobalConfig } from 'payload';
-
-export const GlobalWithAccessControl: GlobalConfig = {
-  // ...
-  access: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Config Options
-
-Access Control is specific to the operation of the request.
-
-To add Access Control to a [Global](../configuration/globals), use the `access` property in the [Global Config](../globals/overview):
-
-```ts
-import { GlobalConfig } from 'payload'
-
-const GlobalWithAccessControl: GlobalConfig = {
-  // ...
-  // highlight-start
-  access: {
-    read: ({ req: { user } }) => {...},
-    update: ({ req: { user } }) => {...},
-
-    // Version-enabled Globals only
-    readVersion: () => {...},
-  },
-  // highlight-end
-}
-
-export default Header
-```
-
-The following options are available:
-
-| Function                | Allows/Denies Access                   |
-| ----------------------- | -------------------------------------- |
-| **`read`**     | Used in the `findOne` Global operation. [More details](#read). |
-| **`update`** | Used in the `update` Global operation. [More details](#update). |
-
-If a Global supports [Versions](../versions/overview), the following additional options are available:
-
-| Function           | Allows/Denies Access                                                                                                   |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| **`readVersions`** | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. [More details](#read-versions). |
-
-### Read
-
-Returns a boolean result or optionally a [query constraint](../queries/overview) which limits who can read this global based on its current properties.
-
-To add read Access Control to a [Global](../configuration/globals), use the `read` property in the [Global Config](../globals/overview):
-
-```ts
-import { GlobalConfig } from 'payload'
-
-const Header: GlobalConfig = {
-  // ...
-  // highlight-start
-  read: {
-    read: ({ req: { user } }) => {
-      return Boolean(user)
-    },
-  }
-  // highlight-end
-}
-```
-
-The following arguments are provided to the `read` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-
-### Update
-
-Returns a boolean result or optionally a [query constraint](../queries/overview) which limits who can update this global based on its current properties.
-
-To add update Access Control to a [Global](../configuration/globals), use the `access` property in the [Global Config](../globals/overview):
-
-```ts
-import { GlobalConfig } from 'payload'
-
-const Header: GlobalConfig = {
-  // ...
-  // highlight-start
-  access: {
-    update: ({ req: { user }, data }) => {
-      return Boolean(user)
-    },
-  }
-  // highlight-end
-}
-```
-
-The following arguments are provided to the `update` function:
-
-| Option     | Description                                                                |
-| ---------- | -------------------------------------------------------------------------- |
-| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-| **`data`** | The data passed to update the global with.                                 |
-
-### Read Versions
-
-If the Global has [Versions](../versions/overview) enabled, the `readVersions` Access Control function determines whether or not the currently logged in user can access the version history of a Document.
-
-To add Read Versions Access Control to a Collection, use the `readVersions` property in the [Global Config](../globals/overview):
-
-```ts
-import type { GlobalConfig } from 'payload'
-
-export const GlobalWithVersionsAccess: GlobalConfig = {
-  // ...
-  access: {
-    // highlight-start
-    readVersions: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `readVersions` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |

docs/access-control/overview.mdx

@@ -1,60 +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, nextjs
----
-
-<YouTube id="DoPLyXG26Dg" title="Overview of Payload Access Control" />
-
-Access Control determines what a user can and cannot do with any given Document, as well as what they can and cannot see within the [Admin Panel](../admin/overview). By implementing Access Control, you can define granular restrictions based on the user, their roles (RBAC), Document data, or any other criteria your application requires.
-
-Access Control functions are scoped to the _operation_, meaning you can have different rules for `create`, `read`, `update`, `delete`, etc. Access Control functions are executed _before_ any changes are made and _before_ any operations are completed. This allows you to determine if the user has the necessary permissions before fulfilling the request.
-
-There are many use cases for Access Control, including:
-
-- Allowing anyone `read` access to all posts
-- Only allowing public access to posts where a `status` field is equal to `published`
-- Giving only users with a `role` field equal to `admin` the ability to delete posts
-- Allowing anyone to submit contact forms, but only logged in users to `read`, `update` or `delete` them
-- Restricting a user to only be able to see their own orders, but noone else's
-- Allowing users that belong to a certain organization to access only that organization's resources
-
-There are three main types of Access Control in Payload:
-
-- [Collection Access Control](./collections)
-- [Global Access Control](./globals)
-- [Field Access Control](./fields)
-
-## Default Access Control
-
-Payload provides default Access Control so that your data is secured behind [Authentication](../authentication) without additional configuration. To do this, Payload sets a default function that simply checks if a user is present on the request. You can override this default behavior by defining your own Access Control functions as needed.
-
-Here is the default Access Control that Payload provides:
-
-```ts
-const defaultPayloadAccess = ({ req: { user } }) => {
-  // Return `true` if a user is found
-  // and `false` if it is undefined or null
-  return Boolean(user) // highlight-line
-}
-```
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  In the [Local API](../local-api/overview), all Access Control is _skipped_ by default. This allows your server to have full control over your application. To opt back in, you can set the `overrideAccess` option to `false` in your requests.
-</Banner>
-
-## The Access Operation
-
-The Admin Panel responds dynamically to your changes to Access Control. For example, if you restrict editing `ExampleCollection` to only users that feature an "admin" role, Payload will **hide** that Collection from the Admin Panel entirely. This is super powerful and allows you to control who can do what within your Admin Panel using the same functions that secure your APIs.
-
-To accomplish this, Payload exposes the [Access Operation](../authentication/operations#access). Upon login, Payload executes each Access Control function at the top level, across all Collections, Globals, and Fields, and returns a response that contains a reflection of what the currently authenticated user can do within your application.
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  When your access control functions are executed via the [Access Operation](../authentication/operations#access),  the `id` and `data` arguments will be `undefined`. This is 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 Panel.

docs/admin/collections.mdx

@@ -1,173 +0,0 @@
----
-title: Collection Admin Config
-label: Collections
-order: 20
-desc:
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-The behavior of [Collections](../configuration/collections) within the [Admin Panel](./overview) can be fully customized to fit the needs of your application. This includes grouping or hiding their navigation links, adding [Custom Components](./components), selecting which fields to display in the List View, and more.
-
-To configure Admin Options for Collections, use the `admin` property in your Collection Config:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const MyCollection: CollectionConfig = {
-  // ...
-  admin: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Admin Options
-
-The following options are available:
-
-| 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 details](../hooks/collections).                                                                                                                                       |
-| **`useAsTitle`**                 | Specify a top-level field to use for a document title throughout the Admin Panel. If no field is defined, the ID of the document is used as the title. A field with `virtual: true` cannot be used as the title.      |
-| **`description`**                | Text to display below the Collection label in the List View to give editors more information. Alternatively, you can use the `admin.components.Description` to render a React component. [More details](#components). |
-| **`defaultColumns`**             | Array of field names that correspond to which columns to show by default in this Collection's List View.                                                                                                              |
-| **`hideAPIURL`**                 | Hides the "API URL" meta field while editing documents within this Collection.                                                                                                                                        |
-| **`enableRichTextLink`**         | The [Rich Text](../fields/rich-text) field features a `Link` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default.                            |
-| **`enableRichTextRelationship`** | The [Rich Text](../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.                    |
-| **`meta`**                       | Page metadata overrides to apply to this Collection within the Admin Panel. [More details](./metadata).                                                                                                               |
-| **`preview`**                    | Function to generate preview URLs within the Admin Panel that can point to your app. [More details](#preview).                                                                                                        |
-| **`livePreview`**                | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                                                                         |
-| **`components`**                 | Swap in your own React components to be used within this Collection. [More details](#components).                                                                                                                     |
-| **`listSearchableFields`**       | Specify which fields should be searched in the List search view. [More details](#list-searchable-fields).                                                                                                             |
-| **`pagination`**                 | Set pagination-specific options for this Collection. [More details](#pagination).                                                                                                                                     |
-
-### Components
-
-Collections can set their own [Custom Components](./components) which only apply to [Collection](../configuration/collections)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
-
-To override Collection Components, use the `admin.components` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollection: SanitizedCollectionConfig = {
-  // ...
-  admin: {
-    components: { // highlight-line
-      // ...
-    },
-  },
-}
-```
-
-The following options are available:
-
-| Path                       | Description                                                                                                            |
-| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| **`beforeList`**           | An array of components to inject _before_ the built-in List View                                                          |
-| **`beforeListTable`**      | An array of components to inject _before_ the built-in List View's table                                                  |
-| **`afterList`**            | An array of components to inject _after_ the built-in List View                                                           |
-| **`afterListTable`**       | An array of components to inject _after_ the built-in List View's table
-| **`Description`**          | A component to render below the Collection label in the List View. An alternative to the `admin.description` property. |
-| **`edit.SaveButton`**      | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled.                                     |
-| **`edit.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. |
-| **`edit.PublishButton`**   | Replace the default Publish Button with a Custom Component. [Drafts](../versions/drafts) must be enabled.                                  |
-| **`edit.PreviewButton`**   | Replace the default Preview Button with a Custom Component. [Preview](#preview) must be enabled.                                         |
-| **`views`**                | Override or create new views within the Admin Panel. [More details](./views).                                     |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components).
-</Banner>
-
-### Preview
-
-It is possible to display a Preview Button within the Edit View of the Admin Panel. This will allow editors to visit the frontend of your app the corresponds to the document they are actively editing. This way they can preview the latest, potentially unpublished changes.
-
-To configure the Preview Button, set the `admin.preview` property to a function in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    preview: (doc, { locale }) => {
-      if (doc?.slug) {
-        return `/${doc.slug}?locale=${locale}`
-      }
-
-      return null
-    },
-    // highlight-end
-  },
-}
-```
-
-The preview function receives two arguments:
-
-| Argument | Description |
-| --- | --- |
-| **`doc`** | The Document being edited. |
-| **`ctx`** | An object containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT. |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For fully working example of this, check of the official [Draft Preview Example](https://github.com/payloadcms/payload/tree/main/examples/draft-preview) in the [Examples Directory](https://github.com/payloadcms/payload/tree/main/examples).
-</Banner>
-
-### Pagination
-
-All Collections receive their own List View which displays a paginated list of documents that can be sorted and filtered. The pagination behavior of the List View can be customized on a per-Collection basis, and uses the same [Pagination](../queries/pagination) API that Payload provides.
-
-To configure pagination options, use the `admin.pagination` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    pagination: {
-      defaultLimit: 10,
-      limits: [10, 20, 50],
-    },
-    // highlight-end
-  },
-}
-```
-
-The following options are available:
-
-| 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. |
-
-### List Searchable Fields
-
-In the List View, there is a "search" box that allows you to quickly find a document through a simple text search. By default, it searches on the ID field. If defined, the `admin.useAsTitle` field is used. Or, you can explicitly define which fields to search based on the needs of your application.
-
-To define which fields should be searched, use the `admin.listSearchableFields` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    listSearchableFields: ['title', 'slug'],
-    // highlight-end
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Tip:</strong>
-  If you are adding `listSearchableFields`, make sure you index each of these fields so your admin queries can remain performant.
-</Banner>

docs/admin/components.mdx

@@ -1,601 +0,0 @@
----
-title: Swap in your own React components
-label: Custom Components
-order: 40
-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, nextjs
----
-
-The Payload [Admin Panel](./overview) is designed to be as minimal and straightforward as possible to allow for both easy customization and full control over the UI. In order for Payload to support this level of customization, Payload provides a pattern for you to supply your own React components through your [Payload Config](../configuration/overview).
-
-All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly on the front-end. Custom Components are available for nearly every part of the Admin Panel for extreme granularity and control.
-
-<Banner type="success">
-  <strong>Note:</strong>
-  Client Components continue to be fully supported. To use Client Components in your app, simply include the `use client` directive. Payload will automatically detect and remove all default, [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component. [More details](#client-components).
-</Banner>
-
-There are four main types of Custom Components in Payload:
-
-- [Root Components](#root-components)
-- [Collection Components](./collections#components)
-- [Global Components](./globals#components)
-- [Field Components](./fields)
-
-To swap in your own Custom Component, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-components) accordingly.
-
-
-## Defining Custom Components in the Payload Config
-
-In the Payload Config, you can define custom React Components to enhance the admin interface. However, these components should not be imported directly into the server-only Payload Config to avoid including client-side code. Instead, you specify the path to the component. Here’s how you can do it:
-
-
-src/components/Logout.tsx
-```tsx
-'use client'
-import React from 'react'
-
-export const MyComponent = () => {
-  return (
-    <button>Click me!</button>
-  )
-}
-```
-
-payload.config.ts:
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: { // highlight-line
-    components: {
-      logout: {
-        Button: '/src/components/Logout#MyComponent'
-      }
-    }
-  },
-})
-```
-
-In the path `/src/components/Logout#MyComponent`, `/src/components/Logout` is the file path, and `MyComponent` is the named export. If the component is the default export, the export name can be omitted. Path and export name are separated by a `#`.
-
-### Configuring the Base Directory
-
-Component paths, by default, are relative to your working directory - this is usually where your Next.js config lies. To simplify component paths, you have the option to configure the *base directory* using the `admin.baseDir.baseDir` property:
-
-```ts
-import { buildConfig } from 'payload'
-import { fileURLToPath } from 'node:url'
-import path from 'path'
-const filename = fileURLToPath(import.meta.url)
-const dirname = path.dirname(filename)
-
-const config = buildConfig({
-  // ...
-  admin: { // highlight-line
-     importMap: {
-      baseDir: path.resolve(dirname, 'src'),
-    },
-    components: {
-      logout: {
-        Button: '/components/Logout#MyComponent'
-      }
-    }
-  },
-})
-```
-
-In this example, we set the base directory to the `src` directory - thus we can omit the `/src/` part of our component path string.
-
-### Passing Props
-
-Each React Component in the Payload Config is typed as `PayloadComponent`. This usually is a string, but can also be an object containing the following properties:
-
-| Property      | Description                                                                                                                   |
-|---------------|-------------------------------------------------------------------------------------------------------------------------------|
-| `clientProps` | Props to be passed to the React Component if it's a Client Component                                                          |
-| `exportName`  | Instead of declaring named exports using `#` in the component path, you can also omit them from `path` and pass them in here. |
-| `path`        | Path to the React Component. Named exports can be appended to the end of the path, separated by a `#`                         |
-| `serverProps` | Props to be passed to the React Component if it's a Server Component                                                          |
-
-To pass in props from the config, you can use the `clientProps` and/or `serverProps` properties. This alleviates the need to use an HOC (Higher-Order-Component) to declare a React Component with props passed in.
-
-Here is an example:
-
-src/components/Logout.tsx
-```tsx
-'use client'
-import React from 'react'
-
-export const MyComponent = ({ text }: { text: string }) => {
-  return (
-    <button>Click me! {text}</button>
-  )
-}
-```
-
-payload.config.ts:
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: { // highlight-line
-    components: {
-      logout: {
-        Button: {
-          path: '/src/components/Logout',
-          clientProps: {
-            text: 'Some Text.'
-          },
-          exportName: 'MyComponent'
-        }
-      }
-    }
-  },
-})
-```
-
-### Import Maps
-
-It's essential to understand how `PayloadComponent` paths function behind the scenes. Directly importing React Components into your Payload Config using import statements can introduce client-only modules like CSS into your server-only config. This could error when attempting to load the Payload Config in server-only environments and unnecessarily increase the size of the Payload Config, which should remain streamlined and efficient for server use.
-
-Instead, we utilize component paths to reference React Components. This method enhances the Payload Config with actual React Component imports on the client side, without affecting server-side usage. A script is deployed to scan the Payload Config, collecting all component paths and creating an `importMap.js`. This file, located in app/(payload)/admin/importMap.js, must be statically imported by your Next.js root page and layout. The script imports all the React Components from the specified paths into a Map, associating them with their respective paths (the ones you defined).
-
-When constructing the `ClientConfig`, Payload uses the component paths as keys to fetch the corresponding React Component imports from the Import Map. It then substitutes the `PayloadComponent` with a `MappedComponent`. A `MappedComponent` includes the React Component and additional metadata, such as whether it's a server or a client component and which props it should receive. These components are then rendered through the `<RenderComponent />` component within the Payload Admin Panel.
-
-Import maps are regenerated whenever you modify any element related to component paths. This regeneration occurs at startup and whenever Hot Module Replacement (HMR) runs. If the import maps fail to regenerate during HMR, you can restart your application and execute the `payload generate:importmap` command to manually create a new import map. If you encounter any errors running this command, see the [Troubleshooting](../local-api/outside-nextjs#troubleshooting) section.
-
-### Component paths in external packages
-
-Component paths are resolved relative to your project's base directory, which is either your current working directory or the directory specified in `config.admin.baseDir`. When using custom components from external packages, you can't use relative paths. Instead, use an import path that's accessible as if you were writing an import statement in your project's base directory.
-
-For example, to export a field with a custom component from an external package named `my-external-package`:
-
-```ts
-import type { Field } from 'payload'
-export const MyCustomField: Field = {
-  type: 'text',
-  name: 'MyField',
-  admin: {
-    components: {
-      Field: 'my-external-package/client#MyFieldComponent'
-    }
-  }
-}
-```
-
-Despite `MyFieldComponent` living in `src/components/MyFieldComponent.tsx` in `my-external-package`, this will not be accessible from the consuming project. Instead, we recommend exporting all custom components from one file in the external package. For example, you can define a `src/client.ts file in `my-external-package`:
-
-```ts
-'use client'
-export { MyFieldComponent } from './components/MyFieldComponent'
-```
-
-Then, update the package.json of `my-external-package:
-
-```json
-{
-...
-  "exports": {
-    "./client": {
-        "import": "./dist/client.js",
-        "types": "./dist/client.d.ts",
-        "default": "./dist/client.js"
-    }
-  }
-}
-```
-
-This setup allows you to specify the component path as `my-external-package/client#MyFieldComponent` as seen above. The import map will generate:
-
-```ts
-import { MyFieldComponent } from 'my-external-package/client'
-```
-
-which is a valid way to access MyFieldComponent that can be resolved by the consuming project.
-
-### Custom Components from unknown locations
-
-By default, any component paths from known locations are added to the import map. However, if you need to add any components from unknown locations to the import map, you can do so by adding them to the `admin.dependencies` array in your Payload Config. This is mostly only relevant for plugin authors and not for regular Payload users.
-
-Example:
-
-```ts
-export default {
-  // ...
-  admin: {
-    // ...
-    dependencies: {
-      myTestComponent: { // myTestComponent is the key - can be anything
-        path: '/components/TestComponent.js#TestComponent',
-        type: 'component',
-        clientProps: {
-          test: 'hello',
-        },
-      },
-    },
-  }
-}
-```
-
-This way, `TestComponent` is added to the import map, no matter if it's referenced in a known location or not. On the client, you can then use the component like this:
-
-```tsx
-'use client'
-
-import { RenderComponent, useConfig } from '@payloadcms/ui'
-import React from 'react'
-
-export const CustomView = () => {
-  const { config } = useConfig()
-  return (
-    <div>
-      <RenderComponent mappedComponent={config.admin.dependencies?.myTestComponent} />
-    </div>
-  )
-}
-```
-
-## Root Components
-
-Root Components are those that effect the [Admin Panel](./overview) generally, such as the logo or the main nav.
-
-To override Root Components, use the `admin.components` property in your [Payload Config](../getting-started/overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  admin: {
-    // highlight-start
-    components: {
-      // ...
-    },
-    // highlight-end
-  },
-})
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](#building-custom-components)._
-
-The following options are available:
-
-| Path                  | Description                                                                                                                                                                                                         |
-|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                                 |
-| **`beforeNavLinks`**  | An array of Custom Components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                       |
-| **`afterNavLinks`**   | An array of Custom Components to inject into the built-in Nav, _after_ the links.                                                                                                                                   |
-| **`beforeDashboard`** | An array of Custom Components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                       |
-| **`afterDashboard`**  | An array of Custom Components to inject into the built-in Dashboard, _after_ the default dashboard contents.                                                                                                        |
-| **`beforeLogin`**     | An array of Custom Components to inject into the built-in Login, _before_ the default login form.                                                                                                                   |
-| **`afterLogin`**      | An array of Custom Components to inject into the built-in Login, _after_ the default login form.                                                                                                                    |
-| **`logout.Button`**   | The button displayed in the sidebar that logs the user out.                                                                                                                                                         |
-| **`graphics.Icon`**   | The simplified logo used in contexts like the the `Nav` component.                                                                                                                                                  |
-| **`graphics.Logo`**   | The full logo used in contexts like the `Login` view.                                                                                                                                                               |
-| **`providers`**       | Custom [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context) providers that will wrap the entire Admin Panel. [More details](#custom-providers).                                       |
-| **`actions`**         | An array of Custom Components to be rendered _within_ the header of the Admin Panel, providing additional interactivity and functionality.                                                                  |
-| **`header`**          | An array of Custom Components to be injected above the Payload header.                                                   |
-| **`views`**           | Override or create new views within the Admin Panel. [More details](./views).                                                                                                                                 |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  You can also use set [Collection Components](./collections#components) and [Global Components](./globals#components) in their respective configs.
-</Banner>
-
-### Custom Providers
-
-As you add more and more Custom Components to your [Admin Panel](./overview), you may find it helpful to add additional [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context)(s). Payload allows you to inject your own context providers in your app so you can export your own custom hooks, etc.
-
-To add a Custom Provider, use the `admin.components.providers` property in your [Payload Config](../getting-started/overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  admin: {
-    components: {
-      providers: ['/path/to/MyProvider'], // highlight-line
-    },
-  },
-})
-```
-
-Then build your Custom Provider as follows:
-
-```tsx
-'use client'
-import React, { createContext, useContext } from 'react'
-
-const MyCustomContext = React.createContext(myCustomValue)
-
-export const MyProvider: React.FC = ({ children }) => {
-  return (
-    <MyCustomContext.Provider value={myCustomValue}>
-      {children}
-    </MyCustomContext.Provider>
-  )
-}
-
-export const useMyCustomContext = () => useContext(MyCustomContext)
-```
-
-<Banner type="warning">
-  <strong>Reminder:</strong> Custom Providers are by definition Client Components. This means they must include the `use client` directive at the top of their files and cannot use server-only code.
-</Banner>
-
-## Building Custom Components
-
-All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly on the front-end, among other things.
-
-To make building Custom Components as easy as possible, Payload automatically provides common props, such as the [`payload`](../local-api/overview) class and the [`i18n`](../configuration/i18n) object. This means that when building Custom Components within the Admin Panel, you do not have to get these yourself.
-
-Here is an example:
-
-```tsx
-import React from 'react'
-
-const MyServerComponent = async ({
-  payload // highlight-line
-}) => {
-  const page = await payload.findByID({
-    collection: 'pages',
-    id: '123',
-  })
-
-  return (
-    <p>{page.title}</p>
-  )
-}
-```
-
-Each Custom Component receives the following props by default:
-
-| Prop                      | Description                                                                                           |
-| ------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `payload`                 | The [Payload](../local-api/overview) class.                                                           |
-| `i18n`                    | The [i18n](../configuration/i18n) object.                                                                           |
-
-Custom Components also receive various other props that are specific to the context in which the Custom Component is being rendered. For example, [Custom Views](./views) receive the `user` prop. For a full list of available props, consult the documentation related to the specific component you are working with.
-
-<Banner type="success">
-  See [Root Components](#root-components), [Collection Components](#collection-components), [Global Components](#global-components), or [Field Components](#custom-field-components) for a complete list of all available components.
-</Banner>
-
-### Client Components
-
-When [Building Custom Components](#building-custom-components), it's still possible to use client-side code such as `useState` or the `window` object. To do this, simply add the `use client` directive at the top of your file. Payload will automatically detect and remove all default, [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component.
-
-```tsx
-'use client' // highlight-line
-import React, { useState } from 'react'
-
-export const MyClientComponent: React.FC = () => {
-  const [count, setCount] = useState(0)
-
-  return (
-    <button onClick={() => setCount(count + 1)}>
-      Clicked {count} times
-    </button>
-  )
-}
-```
-
-<Banner type="warning">
-  <strong>Reminder:</strong>
-  Client Components cannot be passed [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types). If you are rendering your Client Component _from within_ a Server Component, ensure that its props are serializable.
-</Banner>
-
-### Accessing the Payload Config
-
-From any Server Component, the [Payload Config](../configuration/overview) can be accessed directly from the `payload` prop:
-
-```tsx
-import React from 'react'
-
-export default async function MyServerComponent({
-  payload: {
-    config // highlight-line
-  }
-}) {
-  return (
-    <Link href={config.serverURL}>
-      Go Home
-    </Link>
-  )
-}
-```
-
-But, the Payload Config is [non-serializable](https://react.dev/reference/rsc/use-client#serializable-types) by design. It is full of custom validation functions, React components, etc. This means that the Payload Config, in its entirety, cannot be passed directly to Client Components.
-
-For this reason, Payload creates a Client Config and passes it into the Config Provider. This is a serializable version of the Payload Config that can be accessed from any Client Component via the [`useConfig`](./hooks#useconfig) hook:
-
-```tsx
-import React from 'react'
-import { useConfig } from '@payloadcms/ui'
-
-export const MyClientComponent: React.FC = () => {
-  const { config: { serverURL } } = useConfig() // highlight-line
-
-  return (
-    <Link href={serverURL}>
-      Go Home
-    </Link>
-  )
-}
-```
-
-<Banner type="success">
-  See [Using Hooks](#using-hooks) for more details.
-</Banner>
-
-All [Field Components](./fields) automatically receive their respective Field Config through a common [`field`](./fields#the-field-prop) prop:
-
-```tsx
-'use client'
-import React from 'react'
-import type { TextFieldClientComponent } from 'payload'
-
-export const MyClientFieldComponent: TextFieldClientComponent = ({ field: { name } }) => {
-  return (
-    <p>
-      {`This field's name is ${name}`}
-    </p>
-  )
-}
-```
-
-### Using Hooks
-
-To make it easier to [build your Custom Components](#building-custom-components), you can use [Payload's built-in React Hooks](./hooks) in any Client Component. For example, you might want to interact with one of Payload's many React Contexts:
-
-```tsx
-'use client'
-import React from 'react'
-import { useDocumentInfo } from '@payloadcms/ui'
-
-export const MyClientComponent: React.FC = () => {
-  const { slug } = useDocumentInfo() // highlight-line
-
-  return (
-    <p>{`Entity slug: ${slug}`}</p>
-  )
-}
-```
-
-<Banner type="success">
-  See the [Hooks](./hooks) documentation for a full list of available hooks.
-</Banner>
-
-### Getting the Current Language
-
-All Custom Components can support multiple languages to be consistent with Payload's [Internationalization](../configuration/i18n). To do this, first add your translation resources to the [I18n Config](../configuration/i18n).
-
-From any Server Component, you can translate resources using the `getTranslation` function from `@payloadcms/translations`. All Server Components automatically receive the `i18n` object as a prop by default.
-
-```tsx
-import React from 'react'
-import { getTranslation } from '@payloadcms/translations'
-
-export default async function MyServerComponent({ i18n }) {
-  const translatedTitle = getTranslation(myTranslation, i18n) // highlight-line
-
-  return (
-    <p>{translatedTitle}</p>
-  )
-}
-```
-
-The best way to do this within a Client Component is to import the `useTranslation` hook from `@payloadcms/ui`:
-
-```tsx
-import React from 'react'
-import { useTranslation } from '@payloadcms/ui'
-
-export const MyClientComponent: React.FC = () => {
-  const { t, i18n } = useTranslation() // highlight-line
-
-  return (
-    <ul>
-      <li>{t('namespace1:key', { variable: 'value' })}</li>
-      <li>{t('namespace2:key', { variable: 'value' })}</li>
-      <li>{i18n.language}</li>
-    </ul>
-  )
-}
-```
-
-<Banner type="success">
-  See the [Hooks](./hooks) documentation for a full list of available hooks.
-</Banner>
-
-### Getting the Current Locale
-
-All [Custom Views](./views) can support multiple locales to be consistent with Payload's [Localization](../configuration/localization). They automatically receive the `locale` object as a prop by default. This can be used to scope API requests, etc.:
-
-```tsx
-import React from 'react'
-
-export default async function MyServerComponent({ payload, locale }) {
-  const localizedPage = await payload.findByID({
-    collection: 'pages',
-    id: '123',
-    locale,
-  })
-
-  return (
-    <p>{localizedPage.title}</p>
-  )
-}
-```
-
-The best way to do this within a Client Component is to import the `useLocale` hook from `@payloadcms/ui`:
-
-```tsx
-import React from 'react'
-import { useLocale } from '@payloadcms/ui'
-
-const Greeting: React.FC = () => {
-  const locale = useLocale() // highlight-line
-
-  const trans = {
-    en: 'Hello',
-    es: 'Hola',
-  }
-
-  return (
-    <span>{trans[locale.code]}</span>
-  )
-}
-```
-
-<Banner type="success">
-  See the [Hooks](./hooks) documentation for a full list of available hooks.
-</Banner>
-
-### Styling Custom Components
-
-Payload has a robust [CSS Library](./customizing-css) that you can use to style your Custom Components similarly to Payload's built-in styling. This will ensure that your Custom Components match the existing design system, and so that they automatically adapt to any theme changes that might occur.
-
-To apply custom styles, simply import your own `.css` or `.scss` file into your Custom Component:
-
-```tsx
-import './index.scss'
-
-export const MyComponent: React.FC = () => {
-  return (
-    <div className="my-component">
-      My Custom Component
-    </div>
-  )
-}
-```
-
-Then to colorize your Custom Component's background, for example, you can use the following CSS:
-
-```scss
-.my-component {
-  background-color: var(--theme-elevation-500);
-}
-```
-
-Payload also exports its [SCSS](https://sass-lang.com) library for reuse which includes mixins, etc. To use this, simply import it as follows into your `.scss` file:
-
-```scss
-@import '~payload/scss';
-
-.my-component {
-  @include mid-break {
-    background-color: var(--theme-elevation-900);
-  }
-}
-
-```
-
-<Banner type="success">
-  <strong>Note:</strong>
-  You can also drill into Payload's own component styles, or easily apply global, app-wide CSS. More on that [here](./customizing-css).
-</Banner>

docs/admin/customizing-css.mdx

@@ -1,86 +0,0 @@
----
-title: Customizing CSS & SCSS
-label: Customizing CSS
-order: 80
-desc: Customize the 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, nextjs
----
-
-Customizing the Payload [Admin Panel](./overview) through CSS alone is one of the easiest and most powerful ways to customize the look and feel of the dashboard. To allow for this level of customization, Payload:
-
-1. Exposes a [root-level stylesheet](#global-css) for you to easily to inject custom selectors
-1. Provides a [CSS library](#css-library) that can be easily overridden or extended
-1. Uses [BEM naming conventions](http://getbem.com) so that class names are globally accessible
-
-To customize the CSS within the Admin UI, determine scope and change you'd like to make, and then add your own CSS or SCSS to the configuration as needed.
-
-## Global CSS
-
-Global CSS refers to the CSS that is applied to the entire [Admin Panel](./overview). This is where you can have a significant impact to the look and feel of the Admin UI through just a few lines of code.
-
-You can add your own global CSS through the root `custom.scss` file of your app. This file is loaded into the root of the Admin Panel and can be used to inject custom selectors or styles however needed.
-
-Here is an example of how you might target the Dashboard View and change the background color:
-
-```scss
-.dashboard {
-  background-color: red; // highlight-line
-}
-```
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  If you are building [Custom Components](./overview), it is best to import your own stylesheets directly into your components, rather than using the global stylesheet. You can continue to use the [CSS library](#css-library) as needed.
-</Banner>
-
-### Specificity rules
-
-All Payload CSS is encapsulated inside CSS layers under `@layer payload-default`. Any custom css will now have the highest possible specificity.
-
-We have also provided a layer `@layer payload` if you want to use layers and ensure that your styles are applied after payload.
-
-To override existing styles in a way that the previous rules of specificity would be respected you can use the default layer like so
-```css
-@layer payload-default {
-  // my styles within the payload specificity
-}
-```
-
-## Re-using Payload SCSS variables and utilities
-
-You can re-use Payload's SCSS variables and utilities in your own stylesheets by importing it from the UI package.
-
-```scss
-@import '~@payloadcms/ui/scss';
-```
-
-## CSS Library
-
-To make it as easy as possible for you to override default 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, including targeting nested components and their various component states.
-
-You can also override Payload's built-in [CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). These variables are widely consumed by the Admin Panel, so modifying them has a significant impact on the look and feel of the Admin UI.
-
-The following variables are defined and can be overridden:
-
-- [Breakpoints](https://github.com/payloadcms/payload/blob/beta/packages/ui/src/scss/queries.scss)
-- [Colors](https://github.com/payloadcms/payload/blob/beta/packages/ui/src/scss/colors.scss)
-  - 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)
-- [Sizing](https://github.com/payloadcms/payload/blob/beta/packages/ui/src/scss/app.scss)
-  - Horizontal gutter
-  - Transition speeds
-  - Font sizes
-  - Etc.
-
-For an up-to-date, comprehensive list of all available variables, please refer to the [Source Code](https://github.com/payloadcms/payload/blob/main/packages/ui/src/scss).
-
-<Banner type="warning">
-  <strong>Warning:</strong>
-  If you're overriding colors or theme elevations, make sure to consider how [your changes will affect dark mode](#dark-mode).
-</Banner>
-
-#### Dark Mode
-
-Colors are designed to automatically adapt to theme of the [Admin Panel](./overview). By default, Payload automatically overrides all `--theme-elevation` colors 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/fields.mdx

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

docs/admin/globals.mdx

@@ -1,107 +0,0 @@
----
-title: Global Admin Config
-label: Globals
-order: 30
-desc:
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-The behavior of [Globals](../configuration/globals) within the [Admin Panel](./overview) can be fully customized to fit the needs of your application. This includes grouping or hiding their navigation links, adding [Custom Components](./components), setting page metadata, and more.
-
-To configure Admin Options for Globals, use the `admin` property in your Global Config:
-
-```ts
-import { GlobalConfig } from 'payload'
-
-export const MyGlobal: GlobalConfig = {
-  // ...
-  admin: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Admin Options
-
-The following options are available:
-
-| 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 details](#components).                           |
-| **`preview`**     | Function to generate a preview URL within the Admin Panel for this Global that can point to your app. [More details](#preview).           |
-| **`livePreview`** | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).          |
-| **`hideAPIURL`**  | Hides the "API URL" meta field while editing documents within this collection.                                                    |
-| **`meta`**        | Page metadata overrides to apply to this Global within the Admin Panel. [More details](./metadata).                                                                           |
-
-### Components
-
-Globals can set their own [Custom Components](./components) which only apply to [Global](../configuration/globals)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
-
-To override Global Components, use the `admin.components` property in your [Global Config](../configuration/globals):
-
-```ts
-import type { SanitizedGlobalConfig } from 'payload'
-
-export const MyGlobal: SanitizedGlobalConfig = {
-  // ...
-  admin: {
-    components: { // highlight-line
-      // ...
-    },
-  },
-}
-```
-
-The following options are available:
-
-| Path                           | Description                                                                                                            |
-| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| **`elements.SaveButton`**      | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled.                                    |
-| **`elements.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. |
-| **`elements.PublishButton`**   | Replace the default Publish Button with a Custom Component. [Drafts](../versions/drafts) must be enabled.                                  |
-| **`elements.PreviewButton`**   | Replace the default Preview Button with a Custom Component. [Preview](#preview) must be enabled.                                         |
-| **`views`**                    | Override or create new views within the Admin Panel. [More details](./views).                                     |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components).
-</Banner>
-
-### Preview
-
-It is possible to display a Preview Button within the Edit View of the Admin Panel. This will allow editors to visit the frontend of your app the corresponds to the document they are actively editing. This way they can preview the latest, potentially unpublished changes.
-
-To configure the Preview Button, set the `admin.preview` property to a function in your Global Config:
-
-```ts
-import { GlobalConfig } from 'payload'
-
-export const MainMenu: GlobalConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    preview: (doc, { locale }) => {
-      if (doc?.slug) {
-        return `/${doc.slug}?locale=${locale}`
-      }
-
-      return null
-    },
-    // highlight-end
-  },
-}
-```
-
-The preview function receives two arguments:
-
-| Argument | Description |
-| --- | --- |
-| **`doc`** | The Document being edited. |
-| **`ctx`** | An object containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT. |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For fully working example of this, check of the official [Draft Preview Example](https://github.com/payloadcms/payload/tree/main/examples/draft-preview) in the [Examples Directory](https://github.com/payloadcms/payload/tree/main/examples).
-</Banner>

docs/admin/hooks.mdx

@@ -1,949 +0,0 @@
----
-title: React Hooks
-label: React Hooks
-order: 70
-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, nextjs
----
-
-Payload provides a variety of powerful [React Hooks](https://react.dev/reference/react-dom/hooks) that can be used within your own [Custom Components](./components), such as [Custom Fields](./fields). With them, you can interface with Payload itself to build just about any type of complex customization you can think of.
-
-<Banner type="warning">
-  <strong>Reminder:</strong>
-  All Custom Components are [React Server Components](https://react.dev/reference/rsc/server-components) by default. Hooks, on the other hand, are only available in client-side environments. To use hooks, [ensure your component is a client component](./components#client-components).
-</Banner>
-
-## useField
-
-The `useField` hook is used internally within all field components. It manages sending and receiving a field's state from its parent form. When you build a [Custom Field Component](./fields), you will be responsible for sending and receiving the field's `value` to and from the form yourself.
-
-To do so, import the `useField` hook as follows:
-
-```tsx
-'use client'
-import { useField } from '@payloadcms/ui'
-
-const CustomTextField: React.FC = () => {
-  const { value, setValue, path } = useField() // highlight-line
-
-  return (
-    <div>
-      <p>
-        {path}
-      </p>
-      <input
-        onChange={(e) => { setValue(e.target.value) }}
-        value={value}
-      />
-    </div>
-  )
-}
-```
-
-The `useField` hook accepts the following arguments:
-
-| Property          | Description                                                                                                                                                                                                                   |
-| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `path`            | If you do not provide a `path` or a `name`, this hook will look for one using the [`useFieldProps`](#usefieldprops) hook.                                                                                                                         |
-| `validate`        | A validation function executed client-side _before_ submitting the form to the server. Different than [Field-level Validation](../fields/overview#validation) which runs strictly on the server. |
-| `disableFormData` | If `true`, the field will not be included in the form data when the form is submitted.                                                                                                                                         |
-| `hasRows` | If `true`, the field will be treated as a field with rows. This is useful for fields like `array` and `blocks`.                                                                                                                                         |
-
-The `useField` hook returns the following object:
-
-```ts
-type FieldType<T> = {
-  errorMessage?: string
-  errorPaths?: string[]
-  filterOptions?: FilterOptionsResult
-  formInitializing: boolean
-  formProcessing: boolean
-  formSubmitted: boolean
-  initialValue?: T
-  path: string
-  permissions: FieldPermissions
-  readOnly?: boolean
-  rows?: Row[]
-  schemaPath: string
-  setValue: (val: unknown, disableModifyingForm?: boolean) => void
-  showError: boolean
-  valid?: boolean
-  value: T
-}
-```
-
-## useFieldProps
-
-[Custom Field Components](./fields#the-field-component) can be rendered on the server. When using a server component as a custom field component, you can access dynamic props from within any client component rendered by your custom server component. This is done using the `useFieldProps` hook. This is important because some fields can be dynamic, such as when nested in an [`array`](../fields/array) or [`blocks`](../fields/block) field. For example, items can be added, re-ordered, or deleted on-the-fly.
-
-You can use the `useFieldProps` hooks to access dynamic props like `path`:
-
-```tsx
-'use client'
-import { useFieldProps } from '@payloadcms/ui'
-
-const CustomTextField: React.FC = () => {
-  const { path } = useFieldProps() // highlight-line
-
-  return (
-    <div>
-      {path}
-    </div>
-  )
-}
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  The [`useField`](#usefield) hook calls the `useFieldProps` hook internally, so you don't need to use both in the same component unless explicitly needed.
-</Banner>
-
-## useFormFields
-
-There are times when a custom field component needs to have access to data from other fields, and you have a few options to do so. The `useFormFields` hook is a powerful and highly performant way to retrieve a form's field state, as well as to retrieve the `dispatchFields` method, which can be helpful for setting other fields' form states from anywhere within a form.
-
-<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
-'use client'
-import { useFormFields } from '@payloadcms/ui'
-
-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
-'use client'
-import { useAllFormFields } from '@payloadcms/ui'
-import { reduceFieldsToValues, getSiblingData } from 'payload/shared'
-
-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: '/path/to/CustomArrayManagerField',
-        },
-      },
-    },
-  ],
-}`}
-  </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: '/path/to/CustomArrayManagerField',
-        },
-      },
-    },
-  ],
-}`}
-  </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: '/path/to/CustomArrayManagerField',
-        },
-      },
-    },
-  ],
-}`}
-  </pre>
-</>
-        )
-      }
-    ],
-  ]}
-/>
-
-## useCollapsible
-
-The `useCollapsible` hook allows you to control parent collapsibles:
-
-| Property                  | Description                                                                                                   |
-| ------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| **`isCollapsed`**         | 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.                                                                 |
-| **`isWithinCollapsible`** | Determine when you are within another collapsible.                                                            |
-
-**Example:**
-
-```tsx
-'use client'
-import React from 'react'
-
-import { useCollapsible } from '@payloadcms/ui'
-
-const CustomComponent: React.FC = () => {
-  const { isCollapsed, toggle } = useCollapsible()
-
-  return (
-    <div>
-      <p className="field-type">I am {isCollapsed ? '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
-'use client'
-import { useDocumentInfo } from '@payloadcms/ui'
-
-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
-'use client'
-import { useLocale } from '@payloadcms/ui'
-
-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
-'use client'
-import { useAuth } from '@payloadcms/ui'
-import type { 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 retrieve the Payload [Client Config](./components#accessing-the-payload-config).
-
-```tsx
-'use client'
-import { useConfig } from '@payloadcms/ui'
-
-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
-'use client'
-import { useEditDepth } from '@payloadcms/ui'
-
-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
-'use client'
-import { useTheme } from '@payloadcms/ui'
-
-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
-'use client'
-import { useTableColumns } from '@payloadcms/ui'
-
-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>
-  )
-}
-```
-
-## useTableCell
-
-Similar to [`useFieldProps`](#usefieldprops), all [Custom Cell Components](./fields#the-cell-component) are rendered on the server, and as such, only have access to static props at render time. But, some props need to be dynamic, such as the field value itself.
-
-For this reason, dynamic props like `cellData` are managed in their own React context, which can be accessed using the `useTableCell` hook.
-
-```tsx
-'use client'
-import { useTableCell } from '@payloadcms/ui'
-
-const MyComponent: React.FC = () => {
-  const { cellData } = useTableCell() // highlight-line
-
-  return (
-    <div>
-      {cellData}
-    </div>
-  )
-}
-```
-
-## useDocumentEvents
-
-The `useDocumentEvents` hook provides a way of subscribing to cross-document events, such as updates made to nested documents within a drawer. This hook will report document events that are outside the scope of the document currently being edited. This hook provides the following:
-
-| 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
-'use client'
-import { useDocumentEvents } from '@payloadcms/ui'
-
-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/locked-documents.mdx

@@ -1,79 +0,0 @@
----
-title: Document Locking
-label: Document Locking
-order: 90
-desc: Ensure your documents are locked while being edited, preventing concurrent edits from multiple users and preserving data integrity.
-keywords: locking, document locking, edit locking, document, concurrency, Payload, headless, Content Management System, cms, javascript, react, node, nextjs
----
-
-Document locking in Payload ensures that only one user at a time can edit a document, preventing data conflicts and accidental overwrites. When a document is locked, other users are prevented from making changes until the lock is released, ensuring data integrity in collaborative environments.
-
-The lock is automatically triggered when a user begins editing a document within the Admin Panel and remains in place until the user exits the editing view or the lock expires due to inactivity.
-
-## How it works
-
-When a user starts editing a document, Payload locks the document for that user. If another user tries to access the same document, they will be notified that it is currently being edited and can choose one of the following options:
-
-- View in Read-Only Mode: View the document without making any changes.
-- Take Over Editing: Take over editing from the current user, which locks the document for the new editor and notifies the original user.
-- Return to Dashboard: Navigate away from the locked document and continue with other tasks.
-
-The lock will automatically expire after a set period of inactivity, configurable using the duration property in the lockDocuments configuration, after which others can resume editing.
-
-<Banner type="info"> <strong>Note:</strong> If your application does not require document locking, you can disable this feature for any collection by setting the <code>lockDocuments</code> property to <code>false</code>. </Banner>
-
-### Config Options
-
-The lockDocuments property exists on both the Collection Config and the Global Config. By default, document locking is enabled for all collections and globals, but you can customize the lock duration or disable the feature entirely.
-
-Here’s an example configuration for document locking:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  slug: 'posts',
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-    },
-    // other fields...
-  ],
-  lockDocuments: {
-    duration: 600, // Duration in seconds
-  },
-}
-```
-
-#### Locking Options
-
-| Option              | Description                                                                                                                                                                    |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **`lockDocuments`** | Enables or disables document locking for the collection or global. By default, document locking is enabled. Set to an object to configure, or set to false to disable locking. |
-| **`duration`**      | Specifies the duration (in seconds) for how long a document remains locked without user interaction. The default is 300 seconds (5 minutes).                                   |
-
-### Impact on APIs
-
-Document locking affects both the Local API and the REST API, ensuring that if a document is locked, concurrent users will not be able to perform updates or deletes on that document (including globals). If a user attempts to update or delete a locked document, they will receive an error.
-
-Once the document is unlocked or the lock duration has expired, other users can proceed with updates or deletes as normal.
-
-#### Overriding Locks
-
-For operations like update and delete, Payload includes an `overrideLock` option. This boolean flag, when set to `false`, enforces document locks, ensuring that the operation will not proceed if another user currently holds the lock.
-
-By default, `overrideLock` is set to `true`, which means that document locks are ignored, and the operation will proceed even if the document is locked. To enforce locks and prevent updates or deletes on locked documents, set `overrideLock: false`.
-
-```ts
-const result = await payload.update({
-  collection: 'posts',
-  id: '123',
-  data: {
-    title: 'New title',
-  },
-  overrideLock: false, // Enforces the document lock, preventing updates if the document is locked
-})
-```
-
-This option is particularly useful in scenarios where administrative privileges or specific workflows require you to override the lock and ensure the operation is completed.

docs/admin/metadata.mdx

@@ -1,216 +0,0 @@
----
-title: Page Metadata
-label: Metadata
-order: 70
-desc: Customize the metadata of your pages within the Admin Panel
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-Every page within the Admin Panel automatically receives dynamic, auto-generated metadata derived from live document data, the user's current locale, and more, without any additional configuration. This includes the page title, description, og:image and everything in between. Metadata is fully configurable at the root level and cascades down to individual collections, documents, and custom views, allowing for the ability to control metadata on any page with high precision.
-
-Within the Admin Panel, metadata can be customized at the following levels:
-
-- [Root Metadata](#root-metadata)
-- [Collection Metadata](#collection-metadata)
-- [Global Metadata](#global-metadata)
-- [View Metadata](#view-metadata)
-
-All of these types of metadata share a similar structure, with a few key differences on the Root level. To customize metadata, consult the list of available scopes. Determine the scope that corresponds to what you are trying to accomplish, then author your metadata within the Payload Config accordingly.
-
-## Root Metadata
-
-Root Metadata is the metadata that is applied to all pages within the Admin Panel. This is where you can control things like the suffix appended onto each page's title, the favicon displayed in the browser's tab, and the Open Graph data that is used when sharing the Admin Panel on social media.
-
-To customize Root Metadata, use the `admin.meta` key in your Payload Config:
-
-```ts
-{
-  // ...
-  admin: {
-    // highlight-start
-    meta: {
-    // highlight-end
-      title: 'My Admin Panel',
-      description: 'The best admin panel in the world',
-      icons: [
-        {
-          rel: 'icon',
-          type: 'image/png',
-          href: '/favicon.png',
-        },
-      ],
-    },
-  },
-}
-```
-
-The following options are available for Root Metadata:
-
-| Key | Type | Description |
-| --- | --- | --- |
-| **`title`** | `string` | The title of the Admin Panel. |
-| **`description`** | `string` | The description of the Admin Panel. |
-| **`defaultOGImageType`** | `dynamic` (default), `static`, or `off` | The type of default OG image to use. If set to `dynamic`, Payload will use Next.js image generation to create an image with the title of the page. If set to `static`, Payload will use the `defaultOGImage` URL. If set to `off`, Payload will not generate an OG image. |
-| **`icons`** | `IconConfig[]` | An array of icon objects. [More details](#icons) |
-| **`keywords`** | `string` | A comma-separated list of keywords to include in the metadata of the Admin Panel. |
-| **`openGraph`** | `OpenGraphConfig` | An object containing Open Graph metadata. [More details](#open-graph) |
-| **`titleSuffix`** | `string` | A suffix to append to the end of the title of every page. Defaults to "- Payload". |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  These are the _root-level_ options for the Admin Panel. You can also customize [Collection Metadata](./collections), [Global Metadata](./globals), and [Document Metadata](./documents) in their respective configs.
-</Banner>
-
-### Icons
-
-The Icons Config corresponds to the `<link>` tags that are used to specify icons for the Admin Panel. The `icons` key is an array of objects, each of which represents an individual icon. Icons are differentiated from one another by their `rel` attribute, which specifies the relationship between the document and the icon.
-
-The most common icon type is the favicon, which is displayed in the browser tab. This is specified by the `rel` attribute `icon`. Other common icon types include `apple-touch-icon`, which is used by Apple devices when the Admin Panel is saved to the home screen, and `mask-icon`, which is used by Safari to mask the Admin Panel icon.
-
-To customize icons, use the `icons` key within the `admin.meta` object in your Payload Config:
-
-```ts
-{
-  // ...
-  admin: {
-    meta: {
-      // highlight-start
-      icons: [
-      // highlight-end
-        {
-          rel: 'icon',
-          type: 'image/png',
-          href: '/favicon.png',
-        },
-        {
-          rel: 'apple-touch-icon',
-          type: 'image/png',
-          href: '/apple-touch-icon.png',
-        },
-      ],
-    },
-  },
-}
-```
-
-The following options are available for Icons:
-
-| Key | Type | Description |
-| --- | --- | --- |
-| **`rel`** | `string` | The HTML `rel` attribute of the icon. |
-| **`type`** | `string` | The MIME type of the icon. |
-| **`color`** | `string` | The color of the icon. |
-| **`fetchPriority`** | `string` | The [fetch priority](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/fetchPriority) of the icon. |
-| **`media`** | `string` | The [media query](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries) of the icon. |
-| **`sizes`** | `string` | The [sizes](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes) of the icon. |
-| **`url`** | `string` | The URL pointing the resource of the icon. |
-
-### Open Graph
-
-Open Graph metadata is a set of tags that are used to control how URLs are displayed when shared on social media platforms. Open Graph metadata is automatically generated by Payload, but can be customized at the Root level.
-
-To customize Open Graph metadata, use the `openGraph` key within the `admin.meta` object in your Payload Config:
-
-```ts
-{
-  // ...
-  admin: {
-    meta: {
-      // highlight-start
-      openGraph: {
-      // highlight-end
-        description: 'The best admin panel in the world',
-        images: [
-          {
-            url: 'https://example.com/image.jpg',
-            width: 800,
-            height: 600,
-          },
-        ],
-        siteName: 'Payload',
-        title: 'My Admin Panel',
-      },
-    },
-  },
-}
-```
-
-The following options are available for Open Graph Metadata:
-
-| Key | Type | Description |
-| --- | --- | --- |
-| **`description`** | `string` | The description of the Admin Panel. |
-| **`images`** | `OGImageConfig | OGImageConfig[]` | An array of image objects. |
-| **`siteName`** | `string` | The name of the site. |
-| **`title`** | `string` | The title of the Admin Panel. |
-
-## Collection Metadata
-
-Collection Metadata is the metadata that is applied to all pages within any given Collection within the Admin Panel. This metadata is used to customize the title and description of all views within any given Collection, unless overridden by the view itself.
-
-To customize Collection Metadata, use the `admin.meta` key within your Collection Config:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const MyCollection: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    meta: {
-    // highlight-end
-      title: 'My Collection',
-      description: 'The best collection in the world',
-    },
-  },
-}
-```
-
-The Collection Meta config has the same options as the [Root Metadata](#root-metadata) config.
-
-## Global Metadata
-
-Global Metadata is the metadata that is applied to all pages within any given Global within the Admin Panel. This metadata is used to customize the title and description of all views within any given Global, unless overridden by the view itself.
-
-To customize Global Metadata, use the `admin.meta` key within your Global Config:
-
-```ts
-import { GlobalConfig } from 'payload'
-
-export const MyGlobal: GlobalConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    meta: {
-    // highlight-end
-      title: 'My Global',
-      description: 'The best
-    },
-  },
-}
-```
-
-The Global Meta config has the same options as the [Root Metadata](#root-metadata) config.
-
-## View Metadata
-
-View Metadata is the metadata that is applied to specific [Views](./views) within the Admin Panel. This metadata is used to customize the title and description of a specific view, overriding any metadata set at the [Root](#root-metadata), [Collection](#collection-metadata), or [Global](#global-metadata) level.
-
-To customize View Metadata, use the `meta` key within your View Config:
-
-```ts
-{
-  // ...
-  admin: {
-    views: {
-      dashboard: {
-        // highlight-start
-        meta: {
-        // highlight-end
-          title: 'My Dashboard',
-          description: 'The best dashboard in the world',
-        }
-      },
-    },
-  },
-}

docs/admin/overview.mdx

@@ -1,244 +0,0 @@
----
-title: The Admin Panel
-label: Overview
-order: 10
-desc: Manage your data and customize the Payload 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, nextjs
----
-
-Payload dynamically generates a beautiful, [fully type-safe](../typescript/overview) Admin Panel to manage your users and data. It is highly performant, even with 100+ fields, and is translated in over 30 languages. Within the Admin Panel you can manage content, [render your site](../live-preview/overview), preview drafts, [diff versions](../versions/overview), and so much more.
-
-The Admin Panel is designed to [white-label your brand](https://payloadcms.com/blog/white-label-admin-ui). You can endlessly customize and extend the Admin UI by swapping in your own [Custom Components](./components)—everything from simple field labels to entire views can be modified or replaced to perfectly tailor the interface for your editors.
-
-The Admin Panel is written in [TypeScript](https://www.typescriptlang.org) and built with [React](https://react.dev) using the [Next.js App Router](https://nextjs.org/docs/app). It supports [React Server Components](https://react.dev/reference/rsc/server-components), enabling the use of the [Local API](/docs/local-api/overview) on the front-end. You can install Payload into any [existing Next.js app in just one line](../getting-started/installation) and [deploy it anywhere](../production).
-
-<Banner type="success">
-  The Payload Admin Panel is designed to be as minimal and straightforward as possible to allow easy customization and control. [Learn more](./components).
-</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."
-/>
-
-## Project Structure
-
-The Admin Panel serves as the entire HTTP layer for Payload, providing a full CRUD interface for your app. This means that both the [REST](../rest-api/overview) and [GraphQL](../graphql/overview) APIs are simply [Next.js Routes](https://nextjs.org/docs/app/building-your-application/routing) that exist directly alongside your front-end application.
-
-Once you [install Payload](../getting-started/installation), the following files and directories will be created in your app:
-
-```plaintext
-app/
-├─ (payload)/
-├── admin/
-├─── [[...segments]]/
-├──── page.tsx
-├──── not-found.tsx
-├── api/
-├─── [...slug]/
-├──── route.ts
-├── graphql/
-├──── route.ts
-├── graphql-playground/
-├──── route.ts
-├── custom.scss
-├── layout.tsx
-```
-
-<Banner type="info">
-  If you are not familiar with Next.js project structure, you can [learn more about it here](https://nextjs.org/docs/getting-started/project-structure).
-</Banner>
-
-As shown above, all Payload routes are nested within the `(payload)` route group. This creates a boundary between the Admin Panel and the rest of your application by scoping all layouts and styles. The `layout.tsx` file within this directory, for example, is where Payload manages the `html` tag of the document to set proper [`lang`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) and [`dir`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) attributes, etc.
-
-The `admin` directory contains all the _pages_ related to the interface itself, whereas the `api` and `graphql` directories contains all the _routes_ related to the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview). All admin routes are [easily configurable](#customizing-routes) to meet your application's exact requirements.
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  If you don't use the [REST API](../rest/overview) or [GraphQL API](../graphql/overview), you can delete the [Next.js files corresponding to those routes](../admin/overview#project-structure), however, the overhead of this API is completely constrained to these endpoints, and will not slow down or affect Payload outside of the endpoints.
-</Banner>
-
-Finally, the `custom.scss` file is where you can add or override globally-oriented styles in the Admin Panel, such as modify the color palette. Customizing the look and feel through CSS alone is a powerful feature of the Admin Panel, [more on that here](./customizing-css).
-
-All auto-generated files will contain the following comments at the top of each file:
-
-```tsx
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */,
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
-```
-
-## Admin Options
-
-All options for the Admin Panel are defined in your [Payload Config](../configuration/overview) under the `admin` property:
-
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: { // highlight-line
-    // ...
-  },
-})
-```
-
-The following options are available:
-
-| Option        | Description                                                                                                                                                           |
-|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`avatar`**      | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                              |
-| **`autoLogin`**   | Used to automate log-in for dev and demonstration convenience. [More details](../authentication/overview).                                                            |
-| **`buildPath`**   | Specify an absolute path for where to store the built Admin bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                            |
-| **`components`**  | Component overrides that affect the entirety of the Admin Panel. [More details](./components).                                                                        |
-| **`custom`**      | Any custom properties you wish to pass to the Admin Panel.                                                                                                            |
-| **`dateFormat`**  | The date format that will be used for all dates within the Admin Panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                       |
-| **`disable`**     | If set to `true`, the entire Admin Panel will be disabled.                                                                                                            |
-| **`livePreview`** | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                         |
-| **`meta`**        | Base metadata to use for the Admin Panel. [More details](./metadata). |
-| **`routes`**      | Replace built-in Admin Panel routes with your own custom routes. [More details](#customizing-routes).                                                                 |
-| **`theme`**       | Restrict the Admin Panel theme to use only one of your choice. Default is `all`.
-| **`user`**        | The `slug` of the Collection that you want to allow to login to the Admin Panel. [More details](#the-admin-user-collection).                                          |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  These are the _root-level_ options for the Admin Panel. You can also customize [Collection Admin Options](./collections) and [Global Admin Options](./globals) through their respective `admin` keys.
-</Banner>
-
-### The Admin User Collection
-
-To specify which Collection to allow to login to the Admin Panel, pass the `admin.user` key equal to the slug of any auth-enabled Collection:
-
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: {
-    user: 'admins', // highlight-line
-  },
-})
-```
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  <br />
-  The Admin Panel can only be used by a single auth-enabled Collection. To enable authentication for a Collection, simply set `auth: true` in the Collection's configuration. See [Authentication](../authentication/overview) for more information.
-</Banner>
-
-By default, if you have not specified a Collection, Payload will automatically provide a `User` Collection with access to the Admin Panel. You can customize or override the fields and settings of the default `User` Collection by adding your own Collection with `slug: 'users'`. Doing this will force Payload to use your provided `User` Collection instead of its default version.
-
-You can use whatever Collection you'd like to access the Admin Panel as long as the Collection supports [Authentication](/docs/authentication/overview). 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
-
-To do this, specify `admin: { user: 'admins' }` in your config. This will provide access to the Admin Panel to only `admins`. Any users authenticated as `customers` will be prevented from accessing the Admin Panel.  See [Access Control](/docs/access-control/overview) for full details.
-
-### Role-based Access Control
-
-It is also possible to allow multiple user types into the Admin Panel with limited permissions, known as role-based access control (RBAC). For example, you may wish to have two roles within the `admins` Collection:
-
-- `super-admin` - full access to the Admin Panel to perform any action
-- `editor` - limited access to the Admin Panel to only manage content
-
-To do this, add a `roles` or similar field to your auth-enabled Collection, then use the `access.admin` property to grant or deny access based on the value of that field. See [Access Control](/docs/access-control/overview) for full details. For a complete, working example of role-based access control, check out the official [Auth Example](https://github.com/payloadcms/payload/tree/main/examples/auth/payload).
-
-## Customizing Routes
-
-You have full control over the routes that Payload binds itself to. This includes both [Root-level Routes](#root-level-routes) such as the [REST API](../rest-api/overview), and [Admin-level Routes](#admin-level-routes) such as the user's account page. You can customize these routes to meet the needs of your application simply by specifying the desired paths in your config.
-
-### Root-level Routes
-
-Root-level routes are those that are not behind the `/admin` path, such as the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview), or the root path of the Admin Panel itself.
-
-To customize root-level routes, use the `routes` property in your [Payload Config](../configuration/overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  routes: {
-    admin: '/custom-admin-route' // highlight-line
-  }
-})
-```
-
-The following options are available:
-
-| Option              | Default route         | Description                                       |
-|---------------------|-----------------------|---------------------------------------------------|
-| `admin`             | `/admin`              | The Admin Panel itself.                           |
-| `api`               | `/api`                | The [REST API](../rest-api/overview) base path.   |
-| `graphQL`           | `/graphql`            | The [GraphQL API](../graphql/overview) base path. |
-| `graphQLPlayground` | `/graphql-playground` | The GraphQL Playground.                           |
-
-<Banner type="success">
-  <strong>Tip:</strong>
-   You can easily add _new_ routes to the Admin Panel through [Custom Endpoints](../rest-api/overview#custom-endpoints) and [Custom Views](./views).
-</Banner>
-
-#### Customizing Root-level Routes
-
-You can change the Root-level Routes as needed, such as to mount the Admin Panel at the root of your application.
-
-Changing Root-level Routes also requires a change to [Project Structure](#project-structure) to match the new route. For example, if you set `routes.admin` to `/`, you would need to completely remove the `admin` directory from the project structure:
-
-```plaintext
-app/
-├─ (payload)/
-├── [[...segments]]/
-├──── ...
-```
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  If you set Root-level Routes _before_ auto-generating the Admin Panel, your [Project Structure](#project-structure) will already be set up correctly.
-</Banner>
-
-### Admin-level Routes
-
-Admin-level routes are those behind the `/admin` path. These are the routes that are part of the Admin Panel itself, such as the user's account page, the login page, etc.
-
-To customize admin-level routes, use the `admin.routes` property in your [Payload Config](../configuration/overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: {
-    routes: {
-      account: '/my-account' // highlight-line
-    }
-  },
-})
-```
-
-The following options are available:
-
-| Option            | Default route           | Description                                     |
-| ----------------- | ----------------------- | ----------------------------------------------- |
-| `account`         | `/account`              | The user's account page.                        |
-| `createFirstUser` | `/create-first-user`    | The page to create the first user.              |
-| `forgot`          | `/forgot`               | The password reset page.                        |
-| `inactivity`      | `/logout-inactivity`    | The page to redirect to after inactivity.       |
-| `login`           | `/login`                | The login page.                                 |
-| `logout`          | `/logout`               | The logout page.                                |
-| `reset`           | `/reset`                | The password reset page.                        |
-| `unauthorized`    | `/unauthorized`         | The unauthorized page.                          |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  You can also swap out entire _views_ out for your own, using the `admin.views` property of the Payload Config. See [Custom Views](./views) for more information.
-</Banner>
-
-## I18n
-
-The Payload Admin Panel is translated in over [30 languages and counting](https://github.com/payloadcms/payload/tree/beta/packages/translations). Languages are automatically detected based on the user's browser and used by the Admin Panel to display all text in that language. If no language was detected, or if the user's language is not yet supported, English will be chosen. Users can easily specify their language by selecting one from their account page. See [I18n](../configuration/i18n) for more information.
-
-## Light and Dark Modes
-
-Users in the Admin Panel have the ability to choose between light mode and dark mode for their editing experience. Users can select their preferred theme from their account page. Once selected, it is saved to their user's preferences and persisted across sessions and devices. If no theme was selected, the Admin Panel will automatically detect the operation system's theme and use that as the default.

docs/admin/preferences.mdx

@@ -1,161 +0,0 @@
----
-title: Managing User Preferences
-label: Preferences
-order: 70
-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, nextjs
----
-
-As your users interact with the [Admin Panel](./overview), you might want to store their preferences in a persistent manner, so that when they revisit the Admin Panel in a different session or from a different device, 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. Columns in the Collection List View: their active state and order
-1. The user's last active [Locale](../configuration/localization)
-1. The "collapsed" state of `blocks`, `array`, and `collapsible` fields
-1. The last-known state of the `Nav` component, etc.
-
-<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.
-
-```tsx
-'use client'
-import React, { Fragment, useState, useEffect, useCallback } from 'react';
-import { usePreferences } from '@payloadcms/ui'
-
-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/views.mdx

@@ -1,366 +0,0 @@
----
-title: Customizing Views
-label: Customizing Views
-order: 50
-desc:
-keywords:
----
-
-Views are the individual pages that make up the [Admin Panel](./overview), such as the Dashboard, List, and Edit views. One of the most powerful ways to customize the Admin Panel is to create Custom Views. These are [Custom Components](./components) that can either replace built-in views or can be entirely new.
-
-There are four types of views within the Admin Panel:
-
-- [Root Views](#root-views)
-- [Collection Views](#collection-views)
-- [Global Views](#global-views)
-- [Document Views](#document-views)
-
-To swap in your own Custom Views, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-views) accordingly.
-
-## Root Views
-
-Root Views are the main views of the [Admin Panel](./overview). These are views that are scoped directly under the `/admin` route, such as the Dashboard or Account views.
-
-To easily swap Root Views with your own, or to [create entirely new ones](#adding-new-root-views), use the `admin.components.views` property of your root [Payload Config](../configuration/overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: {
-    components: {
-      views: {
-        customView: {
-          Component: '/path/to/MyCustomView#MyCustomView', // highlight-line
-          path: '/my-custom-view',
-        }
-      },
-    },
-  },
-})
-```
-
-Your Custom Root Views can optionally use one of the templates that Payload provides. The most common of these is the Default Template which provides the basic layout and navigation. Here is an example of what that might look like:
-
-```tsx
-import type { AdminViewProps } from 'payload'
-
-import { DefaultTemplate } from '@payloadcms/next/templates'
-import { Gutter } from '@payloadcms/ui'
-import React from 'react'
-
-export const MyCustomView: React.FC<AdminViewProps> = ({
-  initPageResult,
-  params,
-  searchParams,
-}) => {
-  return (
-    <DefaultTemplate
-      i18n={initPageResult.req.i18n}
-      locale={initPageResult.locale}
-      params={params}
-      payload={initPageResult.req.payload}
-      permissions={initPageResult.permissions}
-      searchParams={searchParams}
-      user={initPageResult.req.user || undefined}
-      visibleEntities={initPageResult.visibleEntities}
-    >
-      <Gutter>
-        <h1>Custom Default Root View</h1>
-        <br />
-        <p>This view uses the Default Template.</p>
-      </Gutter>
-    </DefaultTemplate>
-  )
-}
-```
-
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
-The following options are available:
-
-| 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](./overview).                                     |
-
-For more granular control, pass a configuration object instead. Payload exposes the following properties for each view:
-
-| Property           | Description                                                                                                                                                                                |
-| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **`Component`** \* | Pass in the component path that should be rendered when a user navigates to this route.                                                                                                         |
-| **`path`** \*      | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands.                                                                     |
-| **`exact`**        | Boolean. When true, will only match if the path matches the `usePathname()` exactly.                                                                                                     |
-| **`strict`**       | When true, a path that has a trailing slash will only match a `location.pathname` with a trailing slash. This has no effect when there are additional URL segments in the pathname. |
-| **`sensitive`**    | When true, will match if the path is case sensitive.
-| **`meta`**         | Page metadata overrides to apply to this view within the Admin Panel. [More details](./metadata).                                                                           |
-
-_\* An asterisk denotes that a property is required._
-
-### Adding New Views
-
-To add a _new_ views to the [Admin Panel](./overview), simply add your own key to the `views` object with at least a `path` and `Component` property. For example:
-
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: {
-    components: {
-      views: {
-        // highlight-start
-        myCustomView: {
-        // highlight-end
-          Component: '/path/to/MyCustomView#MyCustomViewComponent',
-          path: '/my-custom-view',
-        },
-      },
-    },
-  },
-})
-```
-
-The above example shows how to add a new [Root View](#root-views), but the pattern is the same for [Collection Views](#collection-views), [Global Views](#global-views), and [Document Views](#document-views). For help on how to build your own Custom Views, see [Building Custom Views](#building-custom-views).
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  Routes are cascading, so 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, define your nested route _before_ your parent
-  route.
-</Banner>
-
-## Collection Views
-
-Collection Views are views that are scoped under the `/collections` route, such as the Collection List and Document Edit views.
-
-To easily swap out Collection Views with your own, or to [create entirely new ones](#adding-new-views), use the `admin.components.views` property of your [Collection Config](../collections/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  admin: {
-    components: {
-      views: {
-        edit: {
-          root: {
-            Component: '/path/to/MyCustomEditView', // highlight-line
-          }
-          // other options include:
-          // default
-          // versions
-          // version
-          // api
-          // livePreview
-          // [key: string]
-          // See "Document Views" for more details
-        },
-        list: {
-          Component: '/path/to/MyCustomListView',
-        }
-      },
-    },
-  },
-}
-```
-
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  The `root` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `edit.default` key instead.
-</Banner>
-
-The following options are available:
-
-| Property   | Description                                                                                                       |
-| ---------- | ----------------------------------------------------------------------------------------------------------------- |
-| **`edit`** | The Edit View is used to edit a single document for any given Collection. [More details](#document-views).     |
-| **`list`** | The List View is used to show a list of documents for any given Collection.                                         |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  You can also add _new_ Collection Views to the config by adding a new key to the `views` object with at least a `path` and `Component` property. See [Adding New Views](#adding-new-views) for more information.
-</Banner>
-
-## Global Views
-
-Global Views are views that are scoped under the `/globals` route, such as the Document Edit View.
-
-To easily swap out Global Views with your own or [create entirely new ones](#adding-new-views), use the `admin.components.views` property in your [Global Config](../globals/overview):
-
-```ts
-import type { SanitizedGlobalConfig } from 'payload'
-
-export const MyGlobalConfig: SanitizedGlobalConfig = {
-  // ...
-  admin: {
-    components: {
-      views: {
-        edit: {
-          root: {
-            Component: '/path/to/MyCustomEditView', // highlight-line
-          }
-          // other options include:
-          // default
-          // versions
-          // version
-          // api
-          // livePreview
-          // [key: string]
-        },
-      },
-    },
-  },
-}
-```
-
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  The `root` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `edit.default` key instead.
-</Banner>
-
-The following options are available:
-
-| Property   | Description                                                         |
-| ---------- | ------------------------------------------------------------------- |
-| **`edit`** | The Edit View is used to edit a single document for any given Global. [More details](#document-views). |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  You can also add _new_ Global Views to the config by adding a new key to the `views` object with at least a `path` and `Component` property. See [Adding New Views](#adding-new-views) for more information.
-</Banner>
-
-## Document Views
-
-Document Views are views that are scoped under the `/collections/:collectionSlug/:id` or the `/globals/:globalSlug` route, such as the Edit View or the API View. All Document Views keep their overall structure across navigation changes, such as their title and tabs, and replace only the content below.
-
-To easily swap out Document Views with your own, or to [create entirely new ones](#adding-new-document-views), use the `admin.components.views.Edit[key]` property in your [Collection Config](../collections/overview) or [Global Config](../globals/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionOrGlobalConfig: SanitizedCollectionConfig = {
-  // ...
-  admin: {
-    components: {
-      views: {
-        edit: {
-          api: {
-            Component: '/path/to/MyCustomAPIViewComponent', // highlight-line
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
-<Banner type="warning">
- <strong>Note:</strong>
- If you need to replace the _entire_ Edit View, including _all_ nested Document Views, use the `root` key. See [Custom Collection Views](#collection-views) or [Custom Global Views](#global-views) for more information.
-</Banner>
-
-The following options are available:
-
-| Property          | Description                                                                                                                 |
-| ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| **`root`**        | The Root View overrides all other nested views and routes. No document controls or tabs are rendered when this key is set.  |
-| **`default`**     | The Default View is the primary view in which your document is edited. It is rendered within the "Edit" tab.     |
-| **`versions`**    | The Versions View is used to navigate the version history of a single document. It is rendered within the "Versions" tab. [More details](../versions).                    |
-| **`version`**     | The Version View is used to edit a single version of a document. It is rendered within the "Version" tab. [More details](../versions). |
-| **`api`**         | The API View is used to display the REST API JSON response for a given document. It is rendered within the "API" tab.                                            |
-| **`livePreview`** | The LivePreview view is used to display the Live Preview interface. It is rendered within the "Live Preview" tab. [More details](../live-preview).                        |
-
-### Document Tabs
-
-Each Document View can be given a new tab in the Edit View, if desired. Tabs are highly configurable, from as simple as changing the label to swapping out the entire component, they can be modified in any way. To add or customize tabs in the Edit View, use the `tab` key:
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollection: SanitizedCollectionConfig = {
-  slug: 'my-collection',
-  admin: {
-    components: {
-      views: {
-        edit: {
-          myCustomTab: {
-            Component: '/path/to/MyCustomTab',
-            path: '/my-custom-tab',
-            tab: {
-              Component: '/path/to/MyCustomTabComponent' // highlight-line
-            }
-          },
-          anotherCustomTab: {
-            Component: '/path/to/AnotherCustomView',
-            path: '/another-custom-view',
-            // highlight-start
-            tab: {
-              label: 'Another Custom View',
-              href: '/another-custom-view',
-            }
-            // highlight-end
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-<Banner type="warning">
- <strong>Note:</strong>
- This applies to _both_ Collections _and_ Globals.
-</Banner>
-
-## Building Custom Views
-
-Custom Views are just [Custom Components](./components) rendered at the page-level. To understand how to build Custom Views, first review the [Building Custom Components](./components#building-custom-components) guide. Once you have a Custom Component ready, you can use it as a Custom View.
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  admin: {
-    components: {
-      views: {
-        edit: {
-          Component: '/path/to/MyCustomView' // highlight-line
-        }
-      },
-    },
-  },
-}
-```
-
-Your Custom Views will be provided with the following props:
-
-| Prop                      | Description                                                                                                                            |
-| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| **`initPageResult`**      | An object containing `req`, `payload`, `permissions`, etc.                                                                  |
-| **`clientConfig`**        | The Client Config object. [More details](../components#accessing-the-payload-config).                                                             |
-| **`importMap`**           | The import map object.                                                        |
-| **`params`**              | An object containing the [Dynamic Route Parameters](https://nextjs.org/docs/app/building-your-application/routing/dynamic-routes).     |
-| **`searchParams`**        | An object containing the [Search Parameters](https://developer.mozilla.org/docs/Learn/Common_questions/What_is_a_URL#parameters).      |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive `payload` and `i18n` by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  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>

docs/authentication/api-keys.mdx

@@ -1,81 +0,0 @@
----
-title: API Key Strategy
-label: API Key Strategy
-order: 50
-desc: Enable API key based authentication to interface with Payload.
-keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-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. 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 against Payload, first you need to create a user within Payload, i.e. `dev@thirdparty.com`. From your external application you will need to authenticate with that user, you have two options:
-
-1. Log in each time with that user and receive an expiring token to request with.
-1. Generate a non-expiring API key for that user to request with.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br/>
-  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.
-</Banner>
-
-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](../admin/overview) for each document within the collection that allows you to generate an API key for each user in the Collection.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const ThirdPartyAccess: CollectionConfig = {
-  slug: 'third-party-access',
-  auth: {
-    useAPIKey: true, // highlight-line
-  },
-  fields: [],
-}
-```
-
-User API keys are encrypted within the database, meaning that if your database is compromised,
-your API keys will not be.
-
-<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>
-
-### HTTP Authentication
-
-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](../access-control/overview). 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 Users from '../collections/Users'
-
-const response = await fetch('http://localhost:3000/api/pages', {
-  headers: {
-    Authorization: `${Users.slug} API-Key ${YOUR_API_KEY}`,
-  },
-})
-```
-
-Payload ensures that the same, uniform [Access Control](../access-control/overview) 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 Auth
-
-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 type { CollectionConfig } from 'payload'
-
-export const ThirdPartyAccess: CollectionConfig = {
-  slug: 'third-party-access',
-  auth: {
-    useAPIKey: true,
-    disableLocalStrategy: true, // highlight-line
-  },
-}
-```

docs/authentication/cookies.mdx

@@ -1,131 +0,0 @@
----
-title: Cookie Strategy
-label: Cookie Strategy
-order: 40
-desc: Enable HTTP Cookie based authentication to interface with Payload.
-keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-Payload offers the ability to [Authenticate](./overview) via HTTP-only cookies. These can be read from the responses of `login`, `logout`, `refresh`, and `me` auth operations.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  You can access the logged-in user from within [Access Control](../access-control/overview) and [Hooks](../hooks/overview) through the `req.user` argument. [More details](./token-data).
-</Banner>
-
-### 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 `https://example.com`, and you have logged in and visit `https://example.com/test-page`, your browser will automatically include the Payload authentication cookie for you.
-
-### HTTP Authentication
-
-However, if you use `fetch` or similar APIs to retrieve Payload resources from its REST or GraphQL API, you must 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 including cookies in requests from your app to your Payload API, [read the MDN docs](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>
-  To make sure you have a Payload cookie set properly in your browser after logging in, you can use
-  the browsers Developer Tools > Application > Cookies > [your-domain-here]. The Developer tools
-  will still show HTTP-only cookies.
-</Banner>
-
-### CSRF Attacks
-
-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 popular app `https://payload-finances.com` that allows users to manage finances, send and receive money. As Payload is using HTTP-only cookies, that means that browsers automatically will include cookies when sending requests to your domain - <strong>no matter what page created the request</strong>.
-
-So, if a user of `https://payload-finances.com` is logged in and is browsing around on the internet, they might stumble onto a page with malicious intent. Let's look at an example:
-
-```ts
-// malicious-intent.com
-// makes an authenticated request as on your behalf
-
-const maliciousRequest = await fetch(`https://payload-finances.com/api/me`, {
-  credentials: 'include'
-}).then(res => await res.json())
-```
-
-In this scenario, if your cookie was still valid, malicious-intent.com would be able to make requests like the one above on your behalf. This is a CSRF attack.
-
-### CSRF Prevention
-
-Define domains that your trust and are willing to accept Payload HTTP-only cookie based requests from. Use the `csrf` option on the base Payload Config to do this:
-
-```ts
-// payload.config.ts
-
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  serverURL: 'https://my-payload-instance.com',
-  // highlight-start
-  csrf: [
-    // whitelist of domains to allow cookie auth from
-    'https://your-frontend-app.com',
-    'https://your-other-frontend-app.com',
-    // `config.serverURL` is added by default if defined
-  ],
-  // highlight-end
-  collections: [
-    // collections here
-  ],
-})
-
-export default config
-```
-
-#### Cross domain authentication
-
-If your frontend is on a different domain than your Payload API then you will not be able to use HTTP-only cookies for authentication by default as they will be considered third-party cookies by the browser.
-There are a few strategies to get around this:
-
-##### 1. Use subdomains
-
-Cookies can cross subdomains without being considered third party cookies, for example if your API is at api.example.com then you can authenticate from example.com.
-
-##### 2. Configure cookies
-
-If option 1 isn't possible, then you can get around this limitation by [configuring your cookies](./overview#config-options) on your authentication collection to achieve the following setup:
-
-```
-SameSite: None // allows the cookie to cross domains
-Secure: true // ensures its sent over HTTPS only
-HttpOnly: true // ensures its not accessible via client side JavaScript
-```
-
-Configuration example:
-
-```ts
-{
-  slug: 'users',
-  auth: {
-    cookies: {
-      sameSite: 'None',
-      secure: true,
-    }
-  },
-  fields: [
-    // your auth fields here
-  ]
-},
-```
-
-If you're configuring [cors](../production/preventing-abuse#cross-origin-resource-sharing-cors) in your Payload config, you won't be able to use a wildcard anymore, you'll need to specify the list of allowed domains.
-
-
-<Banner type="success">
-  <strong>Good to know:</strong>
-  Setting up <code>secure: true</code> will not work if you're developing on <code>http://localhost</code> or any non-https domain. For local development you should conditionally set this to <code>false</code> based on the environment.
-</Banner>

docs/authentication/custom-strategies.mdx

@@ -1,94 +0,0 @@
----
-title: Custom Strategies
-label: Custom Strategies
-order: 60
-desc: Create custom authentication strategies to handle everything auth in Payload.
-keywords: authentication, config, configuration, overview, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-<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>
-
-### Creating a strategy
-
-At the core, a strategy is a way to authenticate a user making a request. As of `3.0` we moved away from [Passport](https://www.passportjs.org) in favor of pulling back the curtain and putting you in full control.
-
-A strategy is made up of the following:
-
-| Parameter                   | Description                                                               |
-| --------------------------- | ------------------------------------------------------------------------- |
-| **`name`** \*               | The name of your strategy                                                 |
-| **`authenticate`**&nbsp;\*  | A function that takes in the parameters below and returns a user or null. |
-
-The `authenticate` function is passed the following arguments:
-
-| Argument            | Description                                                                                       |
-| ------------------- | ------------------------------------------------------------------------------------------------- |
-| **`headers`** \*    | The headers on the incoming request. Useful for retrieving identifiable information on a request. |
-| **`payload`** \*    | The Payload class. Useful for authenticating the identifiable information against Payload.        |
-| **`isGraphQL`**     | Whether or not the request was made from a GraphQL endpoint. Default is `false`.                  |
-
-
-### Example Strategy
-
-At its core a strategy simply takes information from the incoming request and returns a user. This is exactly how Payload's built-in strategies function.
-
-Your `authenticate` method should return an object containing a Payload user document and any optional headers that you'd like Payload to set for you when we return a response.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Users: CollectionConfig = {
-  slug: 'users',
-  auth: {
-    disableLocalStrategy: true,
-    // highlight-start
-    strategies: [
-      {
-        name: 'custom-strategy',
-        authenticate: ({ payload, headers }) => {
-          const usersQuery = await payload.find({
-            collection: 'users',
-            where: {
-              code: {
-                equals: headers.get('code'),
-              },
-              secret: {
-                equals: headers.get('secret'),
-              },
-            },
-          })
-
-          return {
-            // Send the user back to authenticate,
-            // or send null if no user should be authenticated
-            user: usersQuery.docs[0] || null,
-
-            // Optionally, you can return headers
-            // that you'd like Payload to set here when
-            // it returns the response
-            responseHeaders: new Headers({
-              'some-header': 'my header value'
-            })
-          }
-        }
-      }
-    ]
-    // highlight-end
-  },
-  fields: [
-    {
-      name: 'code',
-      type: 'text',
-      index: true,
-      unique: true,
-    },
-    {
-      name: 'secret',
-      type: 'text',
-    },
-  ]
-}
-```

docs/authentication/email.mdx

@@ -1,203 +0,0 @@
----
-title: Authentication Emails
-label: Email Verification
-order: 30
-desc: Email Verification allows users to verify their email address before they're account is fully activated. Email Verification ties directly into the Email functionality that Payload provides.
-keywords: authentication, email, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-[Authentication](./overview) ties directly into the [Email](../email) functionality that Payload provides. This allows you to send emails to users for verification, password resets, and more. While Payload provides default email templates for these actions, you can customize them to fit your brand.
-
-## Email Verification
-
-Email Verification forces users to prove they have access to the email address they can authenticate. This will help to reduce spam accounts and ensure that users are who they say they are.
-
-To enable Email Verification, use the `auth.verify` property on your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    verify: true // highlight-line
-  },
-}
-```
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  Verification emails are fully customizable. [More details](#generateEmailHTML).
-</Banner>
-
-The following options are available:
-
-| Option               | Description                                                                                                                                                                                                                         |
-|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`generateEmailHTML`** | Allows for overriding the HTML within emails that are sent to users indicating how to validate their account. [More details](#generateEmailHTML). |
-| **`generateEmailSubject`** | Allows for overriding the subject of the email that is sent to users indicating how to validate their account. [More details](#generateEmailSubject). |
-
-#### 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.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  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>
-  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.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    verify: {
-      // highlight-start
-      generateEmailSubject: ({ req, user }) => {
-        return `Hey ${user.email}, reset your password!`;
-      }
-      // highlight-end
-    }
-  }
-}
-```
-
-## Forgot Password
-
-You can customize how the Forgot Password workflow operates with the following options on the `auth.forgotPassword` property:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    forgotPassword: { // highlight-line
-      // ...
-    },
-  },
-}
-```
-
-The following options are available:
-
-| Option               | Description                                                                                                                                                                                                                         |
-|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`generateEmailHTML`** | Allows for overriding the HTML within emails that are sent to users attempting to reset their password. [More details](#generateEmailHTML). |
-| **`generateEmailSubject`** | Allows for overriding the subject of the email that is sent to users attempting to reset their password. [More details](#generateEmailSubject). |
-
-#### generateEmailHTML
-
-This function 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.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  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>
-  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>
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  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>
-
-The following arguments are passed to the `generateEmailHTML` function:
-
-| Argument | Description                                                                                   |
-|----------|-----------------------------------------------------------------------------------------------|
-| `req`    | The request object.                                                                           |
-| `token`  | The token that is generated for the user to reset their password.                             |
-| `user`   | The user document that is attempting to reset their password.                                 |
-
-#### 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.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    forgotPassword: {
-      // highlight-start
-      generateEmailSubject: ({ req, user }) => {
-        return `Hey ${user.email}, reset your password!`;
-      }
-      // highlight-end
-    }
-  }
-}
-```
-
-The following arguments are passed to the `generateEmailSubject` function:
-
-| Argument | Description                                                                                   |
-|----------|-----------------------------------------------------------------------------------------------|
-| `req`    | The request object.                                                                           |
-| `user`   | The user document that is attempting to reset their password.                                 |

docs/authentication/jwt.mdx

@@ -1,51 +0,0 @@
----
-title: JWT Strategy
-label: JWT Strategy
-order: 40
-desc: Enable JSON Web Token based authentication to interface with Payload.
-keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-Payload offers the ability to [Authenticate](./overview) via JSON Web Tokens (JWT). These can be read from the responses of `login`, `logout`, `refresh`, and `me` auth operations.
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  You can access the logged-in user from within [Access Control](../access-control/overview) and [Hooks](../hooks/overview) through the `req.user` argument. [More details](./token-data).
-</Banner>
-
-### 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 user = await fetch('http://localhost:3000/api/users/login', {
-  method: 'POST',
-  body: JSON.stringify({
-    email: 'dev@payloadcms.com',
-    password: 'password',
-  })
-}).then(req => await req.json())
-
-const request = await fetch('http://localhost:3000', {
-  headers: {
-    Authorization: `JWT ${user.token}`,
-  },
-})
-```
-
-### Omitting The Token
-
-In some cases you may want to prevent the token from being returned from the auth operations. You can do that by setting `removeTokenFromResponse` to `true` like so:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const UsersWithoutJWTs: CollectionConfig = {
-  slug: 'users-without-jwts',
-  auth: {
-    removeTokenFromRepsonse: true, // highlight-line
-  },
-}
-```

docs/authentication/operations.mdx

@@ -1,398 +0,0 @@
----
-title: Authentication Operations
-label: Operations
-order: 20
-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, nextjs
----
-
-Enabling [Authentication](./overview) on a [Collection](../configuration/collections) automatically exposes additional auth-based operations in the [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview).
-
-## 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](../access-control/overview), just as the [Admin Panel](../admin/overview) 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 a `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 executing this operation via the authenticated user.
-
-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
-  }
-}
-```
-
-## 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](../admin/overview) 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`](../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 [Admin Panel](../admin/overview) 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/overview#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,197 +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, nextjs
----
-
-<YouTube
-  id="CT4KafeJjTI"
-  title="Simplified Authentication for Headless CMS: Unlocking Reusability in One Line"
-/>
-
-Authentication is a critical part of any application. Payload provides a secure, portable way to manage user accounts out of the box. Payload Authentication is designed to be used in both the [Admin Panel](../admin/overview), all well as your own external applications, completely eliminating the need for paid, third-party platforms and services.
-
-Here are some common use cases of Authentication in your own applications:
-
-- Customer accounts for an e-commerce app
-- User accounts for a SaaS product
-- P2P apps or social sites where users need to log in and manage their profiles
-- Online games where players need to track their progress over time
-
-When Authentication is enabled on a [Collection](../configuration/collections), Payload injects all necessary functionality to support the entire user flow. This includes all [auth-related operations](./operations) like account creation, logging in and out, and resetting passwords, all [auth-related emails](./email) like email verification and password reset, as well as any necessary UI to manage users from the Admin Panel.
-
-To enable Authentication on a Collection, use the `auth` property in the [Collection Config](../configuration/collection#auth):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Users: CollectionConfig = {
-  // ...
-  auth: true, // highlight-line
-}
-```
-
-![Authentication Admin Panel functionality](https://payloadcms.com/images/docs/auth-admin.jpg)
-_Admin Panel screenshot depicting an Admins Collection with Auth enabled_
-
-## Config Options
-
-Any [Collection](../configuration/collections) can opt-in to supporting Authentication. Once enabled, each Document that is created within the Collection can be thought of as a "user". This enables a complete authentication workflow on your Collection, such as logging in and out, resetting their password, and more.
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  By default, Payload provides an auth-enabled `User` Collection which is used to access the Admin Panel. [More details](../admin/overview#the-admin-user-collection).
-</Banner>
-
-To enable Authentication on a Collection, use the `auth` property in the [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Admins: CollectionConfig = {
-  // ...
-  // 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
-}
-```
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  For default auth behavior, set `auth: true`. This is a good starting point for most applications.
-</Banner>
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  Auth-enabled Collections with be automatically injected with the `hash`, `salt`, and `email` fields. [More details](../fields/overview#field-names).
-</Banner>
-
-The following options are available:
-
-| Option                     | Description                                                                                                                                                                                                                         |
-|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`cookies`**              | Set cookie options, including `secure`, `sameSite`, and `domain`. For advanced users.                                                                                                                                               |
-| **`depth`**                | How many levels deep a `user` document should be populated when creating the JWT and binding the `user` to the `req`. Defaults to `0` and should only be modified if absolutely necessary, as this will affect performance. |
-| **`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.                                                                                     |
-| **`forgotPassword`**       | Customize the way that the `forgotPassword` operation functions. [More details](./email#forgot-password).                                                                                                             |
-| **`lockTime`**             | Set the time (in milliseconds) that a user should be locked out if they fail authentication more times than `maxLoginAttempts` allows for.                                                                                          |
-| **`loginWithUsername`**    | Ability to allow users to login with username/password. [More](/docs/authentication/overview#login-with-username)                                                                                                                     |
-| **`maxLoginAttempts`**     | Only allow a user to attempt logging in X amount of times. Automatically locks out a user from authenticating if this limit is passed. Set to `0` to disable.                                                                       |
-| **`removeTokenFromResponses`** | Set to true if you want to remove the token from the returned authentication API responses such as login or refresh.                                                                                                                                                            |
-| **`strategies`**           | Advanced - an array of custom authentification strategies to extend this collection's authentication with. [More details](./custom-strategies).                                                                         |
-| **`tokenExpiration`**      | How long (in seconds) to keep the user logged in. JWTs and HTTP-only cookies will both expire at the same time.                                                                                                                     |
-| **`useAPIKey`**            | Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection. [More details](./api-keys).                                                                       |
-| **`verify`**               | Set to `true` or pass an object with verification options to require users to verify by email before they are allowed to log into your app. [More details](./email#email-verification).                                  |
-
-### Login With Username
-
-You can allow users to login with their username instead of their email address by setting the `loginWithUsername` property to `true`.
-
-Example:
-
-```ts
-{
-  slug: 'customers',
-  auth: {
-    loginWithUsername: true,
-  },
-}
-```
-
-Or, you can pass an object with additional options:
-
-```ts
-{
-  slug: 'customers',
-  auth: {
-    loginWithUsername: {
-      allowEmailLogin: true, // default: false
-      requireEmail: false, // default: false
-    },
-  },
-}
-```
-
-**`allowEmailLogin`**
-
-If set to `true`, users can log in with either their username or email address. If set to `false`, users can only log in with their username.
-
-**`requireEmail`**
-
-If set to `true`, an email address is required when creating a new user. If set to `false`, email is not required upon creation.
-
-## Auto-Login
-
-For testing and demo purposes you may want to skip forcing the user to login in order to access your application. Typically, all users should be required to login, however, you can speed up local development time by enabling auto-login.
-
-To enable auto-login, set the `autoLogin` property in the [Admin Config](../configuration/admin):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  // highlight-start
-  autoLogin:
-    process.env.NEXT_PUBLIC_ENABLE_AUTOLOGIN === 'true'
-      ? {
-          email: 'test@example.com',
-          password: 'test',
-          prefillOnly: true,
-        }
-      : false,
-  // highlight-end
-})
-```
-
-<Banner type="warning">
-  <strong>Warning:</strong>
-  The recommended way to use this feature is behind an [Environment Variable](../configuration/environment-vars). This will ensure it is _disabled_ in production.
-</Banner>
-
-The following options are available:
-
-| Option            | Description                                                                                                     |
-|-------------------|-----------------------------------------------------------------------------------------------------------------|
-| **`username`**    | The username of the user to login as                                                                            |
-| **`email`**       | The email address of the user to login as                                                                       |
-| **`password`**    | The password of the user to login as. This is only needed if `prefillOnly` is set to true                       |
-| **`prefillOnly`** | If set to true, the login credentials will be prefilled but the user will still need to click the login button. |
-
-## Operations
-
-All auth-related operations are available via Payload's REST, Local, and GraphQL APIs. These operations are automatically added to your Collection when you enable Authentication. [More details](./operations).
-
-## Strategies
-
-Out of the box Payload ships with a three powerful Authentication strategies:
-
-- [HTTP-Only Cookies](./cookies)
-- [JSON Web Tokens (JWT)](./jwt)
-- [API-Keys](./api-keys)
-
-Each of these strategies can work together or independently. You can also create your own custom strategies to fit your specific needs. [More details](./custom-strategies).
-
-### HTTP-Only Cookies
-
-[HTTP-only cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/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 <strong>cannot be read by JavaScript in the browser</strong>, unlike JWT's. [More details](./cookies).
-
-### JSON Web Tokens
-
-JWT (JSON Web Tokens) can also be utilized to perform authentication. Tokens are generated on `login`, `refresh` and `me` operations and can be attached to future requests to authenticate users. [More details](./jwt).
-
-### API Keys
-
-API Keys can be enabled on auth collections. These are particularly useful when you want to authenticate against Payload from a third party service. [More details](./api-keys).
-
-### Custom Strategies
-
-There are cases where these may not be enough for your application. Payload is extendable by design so you can wire up your own strategy when you need to. [More details](./custom-strategies).

docs/authentication/token-data.mdx

@@ -1,107 +0,0 @@
----
-title: Token Data
-label: Token Data
-order: 70
-desc: Storing data for read on the request object.
-keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-During the lifecycle of a request you will be able to access the data you have configured to be stored in the JWT by accessing `req.user`. The user object is automatically appeneded to the request for you.
-
-### Definining Token Data
-
-You can specify what data gets encoded to the Cookie/JWT-Token by setting `saveToJWT` property on fields within your auth collection.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Users: CollectionConfig = {
-  slug: 'users',
-  auth: true,
-  fields: [
-    {
-      // will be stored in the JWT
-      saveToJWT: true,
-      type: 'select',
-      name: 'role',
-      options: [
-        'super-admin',
-        'user',
-      ]
-    },
-    {
-      // the entire object will be stored in the JWT
-      // tab fields can do the same thing!
-      saveToJWT: true,
-      type: 'group',
-      name: 'group1',
-      fields: [
-        {
-          type: 'text',
-          name: 'includeField',
-        },
-        {
-          // will be omitted from the JWT
-          saveToJWT: false,
-          type: 'text',
-          name: 'omitField',
-        },
-      ]
-    },
-    {
-      type: 'group',
-      name: 'group2',
-      fields: [
-        {
-          // will be stored in the JWT
-          // but stored at the top level
-          saveToJWT: true,
-          type: 'text',
-          name: 'includeField',
-        },
-        {
-          type: 'text',
-          name: 'omitField',
-        },
-      ]
-    },
-  ]
-}
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  <br/>
-  If you wish to use a different key other than the field `name`, you can define `saveToJWT` as a string.
-</Banner>
-
-
-### Using Token Data
-
-This is especially helpful when writing [Hooks](../hooks/overview) and [Access Control](../access-control/overview) that depend on user defined fields.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Invoices: CollectionConfig = {
-  slug: 'invoices',
-  access: {
-    read: ({ req, data }) => {
-      if (!req?.user) return false
-      // highlight-start
-      if ({ req.user?.role === 'super-admin'}) {
-        return true
-      }
-      // highlight-end
-      return data.owner === req.user.id
-    }
-  }
-  fields: [
-    {
-      name: 'owner',
-      relationTo: 'users'
-    },
-    // ... other fields
-  ],
-}
-```

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](../admin/overview) must be prefixed
-  with `NEXT_PUBLIC_`.  Learn more
-  [here](../configuration/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,127 +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](../admin/overview) must be prefixed with `NEXT_PUBLIC_`. [More details](../configuration/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](../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'
-
-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,107 +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, nextjs
----
-
-A Collection is a group of records, called Documents, that all share a common schema. You can define as many Collections as your application needs. Each Document in a Collection is stored in the [Database](../database/overview) based on the [Fields](../fields/overview) that you define, and automatically generates a [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview) used to manage your Documents.
-
-Collections are also used to achieve [Authentication](../authentication/overview) in Payload. By defining a Collection with `auth` options, that Collection receives additional operations to support user authentication.
-
-Collections are the primary way to structure recurring data in your application, such as users, products, pages, posts, and other types of content that you might want to manage. Each Collection can have its own unique [Access Control](../access-control/overview), [Hooks](../hooks/overview), [Admin Options](#admin-options), and more.
-
-To define a Collection Config, use the `collection` property in your [Payload Config](./overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  collections: [ // highlight-line
-    // Your Collections go here
-  ],
-})
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  If your Collection is only ever meant to contain a single Document, consider using a [Global](./globals) instead.
-</Banner>
-
-## Config Options
-
-It's often best practice to write your Collections in separate files and then import them into the main [Payload Config](../overview).
-
-Here is what a simple Collection Config might look like:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  slug: 'posts',
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-    }
-  ]
-}
-```
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
-</Banner>
-
-The following options are available:
-
-| Option                 | Description                                                                                                                                                                                    |
-|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`admin`**            | The configuration options for the Admin Panel. [More details](../admin/collections).                                                                                                           |
-| **`access`**           | Provide Access Control functions to define exactly who should be able to do what with Documents in this Collection. [More details](../access-control/collections).                             |
-| **`auth`**             | Specify options if you would like this Collection to feature authentication. [More details](../authentication/overview).                                                                       |
-| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                                      |
-| **`disableDuplicate`** | When true, do not show the "Duplicate" button while editing documents within this Collection and prevent `duplicate` from all APIs.                                                            |
-| **`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.                                     |
-| **`dbName`**           | Custom table or Collection name depending on the Database Adapter. Auto-generated from slug if not defined.                                                                                    |
-| **`endpoints`**        | Add custom routes to the REST API. Set to `false` to disable routes. [More details](../rest-api/overview#custom-endpoints).                                                                    |
-| **`fields`** \*        | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview).                                        |
-| **`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.                                  |
-| **`hooks`**            | Entry point for Hooks. [More details](../hooks/overview#collection-hooks).                                                                                                                     |
-| **`labels`**           | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                 |
-| **`lockDocuments`**    | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). |
-| **`slug`** \*          | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                |
-| **`timestamps`**       | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                             |
-| **`typescript`**       | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                            |
-| **`upload`**           | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](../upload/overview) documentation.                                                  |
-| **`versions`**         | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#collection-config).                                                            |
-
-_\* An asterisk denotes that a property is required._
-
-### Fields
-
-Fields define the schema of the Documents within a Collection. To learn more, go to the [Fields](../fields/overview) documentation.
-
-### Access Control
-
-[Collection Access Control](../access-control/overview) determines what a user can and cannot do with any given Document within a Collection. To learn more, go to the [Access Control](../access-control/overview) documentation.
-
-### Hooks
-
-[Collection Hooks](../hooks/collections) allow you to tie into the lifecycle of your Documents so you can execute your own logic during specific events. To learn more, go to the [Hooks](../hooks/overview) documentation.
-
-### Admin Options
-
-You can customize the way that the [Admin Panel](../admin/overview) behaves on a Collection-by-Collection basis. To learn more, go to the [Collection Admin Options](../admin/collections) documentation.
-
-## TypeScript
-
-You can import types from Payload to help make writing your Collection configs easier and type-safe. There are two main types that represent the Collection Config, `CollectionConfig` and `SanitizeCollectionConfig`.
-
-The `CollectionConfig` type represents a raw Collection Config in its full form, where only the bare minimum properties are marked as required. The `SanitizedCollectionConfig` type represents a Collection Config after it has been fully sanitized. Generally, this is only used internally by Payload.
-
-```ts
-import type { CollectionConfig, SanitizedCollectionConfig } from 'payload'
-```

docs/configuration/environment-vars.mdx

@@ -1,101 +0,0 @@
----
-title: Environment Variables
-label: Environment Variables
-order: 100
-desc: Learn how to use Environment Variables in your Payload project
----
-
-Environment Variables are a way to store sensitive information that your application needs to function. This could be anything from API keys to [Database](../database/overview) credentials. Payload allows you to easily use Environment Variables within your config and throughout your application.
-
-## Next.js Applications
-
-If you are using Next.js, no additional setup is required other than creating your `.env` file.
-
-To use Environment Variables, add a `.env` file to the root of your project:
-
-```plaintext
-project-name/
-├─ .env
-├─ package.json
-├─ payload.config.ts
-```
-
-Here is an example of what an `.env` file might look like:
-
-```plaintext
-SERVER_URL=localhost:3000
-DATABASE_URI=mongodb://localhost:27017/my-database
-```
-
-To use Environment Variables in your Payload Config, you can access them directly from `process.env`:
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  serverURL: process.env.SERVER_URL, // highlight-line
-  // ...
-})
-```
-
-## Client-side Environments
-
-For security and safety reasons, the [Admin Panel](../admin/overview) does **not** include Environment Variables in its _client-side_ bundle by default. But, Next.js provides a mechanism to expose Environment Variables to the client-side bundle when needed.
-
-If you are building a [Custom Component](../admin/components) and need to access Environment Variables from the client-side, you can do so by prefixing them with `NEXT_PUBLIC_`.
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  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 sensitive information. Only ever include keys that are safe for the public to read in plain text.
-</Banner>
-
-For example, if you've got the following Environment Variable:
-
-```bash
-NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXX
-```
-
-This key will automatically be made available to the client-side Payload bundle and can be referenced in your Custom Component as follows:
-
-```tsx
-'use client'
-import React from 'react'
-
-const stripeKey = process.env.NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY // highlight-line
-
-const MyClientComponent = () => {
-  // do something with the key
-
-  return (
-    <div>
-      My Client Component
-    </div>
-  )
-}
-```
-
-For more information, check out the [Next.js Documentation](https://nextjs.org/docs/app/building-your-application/configuring/environment-variables).
-
-## Outside of Next.js
-
-If you are using Payload outside of Next.js, we suggest using the [`dotenv`](https://www.npmjs.com/package/dotenv) package to handle Environment Variables from `.env` files. This will automatically load your Environment Variables into `process.env`.
-
-To do this, import the package as high up in your application as possible:
-
-```ts
-import dotenv from 'dotenv'
-dotenv.config() // highlight-line
-
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  serverURL: process.env.SERVER_URL,
-  // ...
-})
-```
-
-<Banner type="warning">
-  <strong>Tip:</strong>
-  Be sure that `dotenv` can find your `.env` file. By default, it will look for a file named `.env` in the root of your project. If you need to specify a different file, pass the path into the config options.
-</Banner>
-

docs/configuration/globals.mdx

@@ -1,111 +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, nextjs
----
-
-Globals are in many ways similar to [Collections](../configuration/collections), except they correspond to only a single Document. You can define as many Globals as your application needs. Each Global Document is stored in the [Database](../database/overview) based on the [Fields](../fields/overview) that you define, and automatically generates a [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview) used to manage your Documents.
-
-Globals are the primary way to structure singletons in Payload, such as a header navigation, site-wide banner alerts, or app-wide localized strings. Each Global can have its own unique [Access Control](../access-control/overview), [Hooks](../hooks/overview), [Admin Options](#admin-options), and more.
-
-To define a Global Config, use the `globals` property in your [Payload Config](./overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  globals: [ // highlight-line
-    // Your Globals go here
-  ],
-})
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  If you have more than one Global that share the same structure, consider using a [Collection](../configuration/collections) instead.
-</Banner>
-
-## Config Options
-
-It's often best practice to write your Globals in separate files and then import them into the main [Payload Config](./overview).
-
-Here is what a simple Global Config might look like:
-
-```ts
-import { GlobalConfig } from 'payload'
-
-export 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,
-        },
-      ],
-    },
-  ],
-}
-```
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
-</Banner>
-
-The following options are available:
-
-| Option              | Description                                                                                                                                                                                    |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`access`**        | Provide Access Control functions to define exactly who should be able to do what with this Global. [More details](../access-control/globals).                                                  |
-| **`admin`**         | The configuration options for the Admin Panel. [More details](../admin/globals).                                                                                                               |
-| **`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.                                                                    |
-| **`description`**   | Text or React component to display below the Global header to give editors more information.                                                                                                   |
-| **`endpoints`**     | Add custom routes to the REST API. [More details](../rest-api/overview#custom-endpoints).                                                                                                      |
-| **`fields`** \*     | Array of field types that will determine the structure and functionality of the data stored within this Global. [More details](../fields/overview).                                            |
-| **`graphQL.name`**  | Text used in schema generation. Auto-generated from slug if not defined.                                                                                                                       |
-| **`hooks`**         | Entry point for Hooks. [More details](../hooks/overview#global-hooks).                                                                                                                         |
-| **`label`**         | Text for the name in the Admin Panel or an object with keys for each language. Auto-generated from slug if not defined.                                                                        |
-| **`lockDocuments`** | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). |
-| **`slug`** \*       | Unique, URL-friendly string that will act as an identifier for this Global.                                                                                                                    |
-| **`typescript`**    | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                            |
-| **`versions`**      | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#globals-config).                                                               |
-
-_\* An asterisk denotes that a property is required._
-
-### Fields
-
-Fields define the schema of the Global. To learn more, go to the [Fields](../fields/overview) documentation.
-
-### Access Control
-
-[Global Access Control](../access-control/globals) determines what a user can and cannot do with any given Global Document. To learn more, go to the [Access Control](../access-control/overview) documentation.
-
-### Hooks
-
-[Global Hooks](../hooks/globals) allow you to tie into the lifecycle of your Documents so you can execute your own logic during specific events. To learn more, go to the [Hooks](../hooks/overview) documentation.
-
-### Admin Options
-
-You can customize the way that the [Admin Panel](../admin/overview) behaves on a Global-by-Global basis. To learn more, go to the [Global Admin Options](../admin/globals) documentation.
-
-## TypeScript
-
-You can import types from Payload to help make writing your Global configs easier and type-safe. There are two main types that represent the Global Config, `GlobalConfig` and `SanitizeGlobalConfig`.
-
-The `GlobalConfig` type represents a raw Global Config in its full form, where only the bare minimum properties are marked as required. The `SanitizedGlobalConfig` type represents a Global Config after it has been fully sanitized. Generally, this is only used internally by Payload.
-
-```ts
-import type { GlobalConfig, SanitizedGlobalConfig } from 'payload'
-```

docs/configuration/i18n.mdx

@@ -1,256 +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, nextjs
----
-
-The [Admin Panel](../admin/overview) is translated in over [30 languages and counting](https://github.com/payloadcms/payload/tree/beta/packages/translations). With I18n, editors can navigate the interface and read API error messages in their preferred language. This is similar to [Localization](./localization), but instead of managing translations for the data itself, you are managing translations for your application's interface.
-
-By default, Payload comes with preinstalled with English, but you can easily load other languages into your own application. Languages are automatically detected based on the request. If no language was detected, or if the user's language is not yet supported by your application, English will be chosen.
-
-To configure I18n, use the `i18n` key in your [Payload Config](./overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  i18n: { // highlight-line
-    // ...
-  },
-})
-```
-
-<Banner type="success">
-  <strong>Note:</strong>
-  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>
-
-## Config Options
-
-You can easily customize and override any of the i18n settings that Payload provides by default. Payload will use your custom options and merge them in with its own.
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  // highlight-start
-  i18n: {
-    fallbackLanguage: 'en', // default
-  }
-  // highlight-end
-})
-```
-
-The following options are available:
-
-| Option                | Description                                                                                                                                                                                                                   |
-| --------------------- | --------------------------------|
-| **`fallbackLanguage`**     | The language to fall back to if the user's preferred language is not supported. Default is `'en'`.                                                                                                                           |
-| **`translations`**    | An object containing the translations. The keys are the language codes and the values are the translations.                                                                                                                |
-| **`supportedLanguages`** | An object containing the supported languages. The keys are the language codes and the values are the translations.                                                                                                         |
-
-## Adding Languages
-
-You can easily add new languages to your Payload app by providing the translations for the new language. Payload maintains a number of built-in translations that can be imported from `@payloadcms/translations`, but you can also provide your own [Custom Translations](#custom-translations) to support any language.
-
-To add a new language, use the `i18n.supportedLanguages` key in your [Payload Config](./overview):
-
-```ts
-import { buildConfig } from 'payload'
-import { en } from '@payloadcms/translations/languages/en'
-import { de } from '@payloadcms/translations/languages/de'
-
-export default buildConfig({
-  // ...
-  // highlight-start
-  i18n: {
-    supportedLanguages: { en, de },
-  },
-  // highlight-end
-})
-```
-
-<Banner type="warning">
- <strong>Tip:</strong>
- It's best to only support the languages that you need so that the bundled JavaScript is kept to a minimum for your project.
-</Banner>
-
-### Custom Translations
-
-You can customize Payload's built-in translations either by extending existing languages or by adding new languages entirely. This can be done by injecting new translation strings into existing languages, or by providing an entirely new language keys altogether.
-
-To add Custom Translations, use the `i18n.translations` key in your [Payload Config](./overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  //...
-  i18n: {
-    // highlight-start
-    translations: {
-      en: {
-        custom: {
-          // namespace can be anything you want
-          key1: 'Translation with {{variable}}', // translation
-        },
-        // override existing translation keys
-        general: {
-          dashboard: 'Home',
-        },
-      },
-    },
-    // highlight-end
-  },
-  //...
-})
-```
-
-### Project Translations
-
-While Payload's built-in features come fully translated, you may also want to translate parts of your own project. This is possible in places like [Collections](./collections) and [Globals](./globals), such as on their labels and groups, field labels, descriptions or input placeholder text.
-
-To do this, provide the translations wherever applicable, keyed to the language code:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Articles: CollectionConfig = {
-  slug: 'articles',
-  labels: {
-    singular: {
-      // highlight-start
-      en: 'Article',
-      es: 'Artículo',
-      // highlight-end
-    },
-    plural: {
-      // highlight-start
-      en: 'Articles',
-      es: 'Artículos',
-      // highlight-end
-    },
-  },
-  admin: {
-    group: {
-      // highlight-start
-      en: 'Content',
-      es: 'Contenido',
-      // highlight-end
-    },
-  },
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-      label: {
-        // highlight-start
-        en: 'Title',
-        es: 'Título',
-        // highlight-end
-      },
-      admin: {
-        placeholder: {
-          // highlight-start
-          en: 'Enter title',
-          es: 'Introduce el título'
-          // highlight-end
-        },
-      },
-    },
-  ],
-}
-```
-
-## Node
-
-Payload's backend sets 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 Payload's extensive internationalization features assigned to `req.i18n`. To access text translations you can use `req.t('namespace:key')`.
-
-## TypeScript
-
-In order to use custom translations in your project, you need to provide the types for the translations.
-
-Here we create a shareable translations object. We will import this in both our custom components and in our Payload config.
-
-```ts
-// <rootDir>/custom-translations.ts
-
-import type { Config } from 'payload'
-import type { NestedKeysStripped } from '@payloadcms/translations'
-
-export const customTranslations: Config['i18n']['translations'] = {
-  en: {
-    general: {
-      myCustomKey: 'My custom english translation',
-    },
-    fields: {
-      addLabel: 'Add!',
-    }
-  },
-}
-
-export type CustomTranslationsObject = typeof customTranslations.en
-export type CustomTranslationsKeys = NestedKeysStripped<CustomTranslationsObject>
-```
-
-Import the shared translations object into our Payload config so they are available for use:
-
-```ts
-// <rootDir>/payload.config.ts
-
-import { buildConfig } from 'payload'
-
-import { customTranslations } from './custom-translations'
-
-export default buildConfig({
-  //...
-  i18n: {
-    translations: customTranslations,
-  },
-  //...
-})
-```
-
-Import the shared translation types to use in your [Custom Component](../admin/components):
-
-```ts
-// <rootDir>/components/MyComponent.tsx
-
-'use client'
-import type React from 'react'
-import { useTranslation } from '@payloadcms/ui'
-
-import type { CustomTranslationsObject, CustomTranslationsKeys } from '../custom-translations'
-
-export const MyComponent: React.FC = () => {
-  const { i18n, t } = useTranslation<CustomTranslationsObject, CustomTranslationsKeys>() // These generics merge your custom translations with the default client translations
-
-  return t('general:myCustomKey')
-}
-```
-
-Additionally, Payload exposes the `t` function in various places, for example in labels. Here is how you would type those:
-
-```ts
-// <rootDir>/fields/myField.ts
-
-import type { DefaultTranslationKeys, TFunction } from '@payloadcms/translations'
-import type { Field } from 'payload'
-
-import { CustomTranslationsKeys } from '../custom-translations'
-
-const field: Field = {
-  name: 'myField',
-  type: 'text',
-  label: (
-    { t }: { t: TFunction<CustomTranslationsKeys | DefaultTranslationKeys> }, // The generic passed to TFunction does not automatically merge the custom translations with the default translations. We need to merge them ourselves here
-  ) => t('fields:addLabel'),
-}
-```
-