chore(release): db-postgres/0.1.5

chore: only imports drizzle-kit if it will be used

.editorconfig

@@ -19,3 +19,7 @@ indent_size = 2
 [*.mdx]
 indent_style = space
 indent_size = 2
+
+[*.json]
+indent_style = space
+indent_size = 2

.eslintignore

@@ -0,0 +1,10 @@
+.tmp
+**/.git
+**/.hg
+**/.pnp.*
+**/.svn
+**/.yarn/**
+**/build
+**/dist/**
+**/node_modules
+**/temp

.eslintrc.cjs

@@ -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,
+}

.eslintrc.js

@@ -1,104 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaVersion: 2020,
-    sourceType: 'module',
-    ecmaFeatures: {
-      jsx: true,
-    },
-  },
-  plugins: [
-    '@typescript-eslint',
-  ],
-  extends: [
-    '@trbl',
-  ],
-  settings: {
-    'import/resolver': {
-      node: {
-        extensions: ['.js', '.jsx', '.ts', '.tsx'],
-      },
-    },
-  },
-  overrides: [
-    {
-      files: ['test/**/int.spec.ts'],
-      rules: {
-        '@typescript-eslint/no-use-before-define': 'off',
-        '@typescript-eslint/consistent-type-imports': 'warn',
-        'jest/prefer-strict-equal': 'off',
-      }
-    },
-    {
-      files: ['test/**/e2e.spec.ts'],
-      extends: [
-        'plugin:playwright/playwright-test'
-      ],
-      rules: {
-        'jest/consistent-test-it': 'off',
-        'jest/require-top-level-describe': 'off',
-        'jest/no-test-callback': 'off',
-        'jest/prefer-strict-equal': 'off',
-        'jest/expect-expect': 'off',
-        'jest-dom/prefer-to-have-attribute': 'off',
-      }
-    },
-    {
-      files: ['*.ts', '*.tsx'],
-      parser: '@typescript-eslint/parser',
-      extends: [
-        'plugin:@typescript-eslint/recommended',
-      ],
-      rules: {
-        'no-shadow': 'off',
-        '@typescript-eslint/no-shadow': ['error'],
-        'import/no-unresolved': [
-          2,
-          {
-            ignore: [
-              'payload-config',
-              'payload/generated-types',
-            ],
-          },
-        ],
-      },
-    },
-    {
-      files: ['*.spec.ts'],
-      rules: {
-        '@typescript-eslint/no-use-before-define': 'off',
-      },
-    },
-    {
-      files: ['*.e2e.ts'],
-      rules: {
-        '@typescript-eslint/no-use-before-define': 'off',
-        'jest/expect-expect': 'off',
-      },
-    },
-  ],
-  rules: {
-    'import/no-extraneous-dependencies': ['error', { packageDir: './' }],
-    'react/jsx-filename-extension': [2, { extensions: ['.js', '.jsx', '.ts', '.tsx'] }],
-    'import/prefer-default-export': 'off',
-    'react/prop-types': 'off',
-    'react/require-default-props': 'off',
-    'react/no-unused-prop-types': 'off',
-    'no-console': 'warn',
-    'no-sparse-arrays': 'off',
-    'no-underscore-dangle': 'off',
-    'no-use-before-define': 'off',
-    'arrow-body-style': 0,
-    '@typescript-eslint/no-use-before-define': 'off',
-    'import/extensions': [
-      'error',
-      'ignorePackages',
-      {
-        js: 'never',
-        jsx: 'never',
-        ts: 'never',
-        tsx: 'never',
-      },
-    ],
-  },
-};

.git-blame-ignore-revs

@@ -0,0 +1,18 @@
+# lint and format
+ae7d6f97d205491390f15850e5104c7abded1550
+1fbda85cd04a774cb978778b0f813001664c53dd
+
+# prettier all templates
+75a428ddc4672903455998eaba7ae9f9d710bf85
+
+# re-run prettier and eslint everywhere again
+cdaa0acd61d3001407609915bd573b78565d5571
+
+# prettier write again
+dfac7395fed95fc5d8ebca21b786ce70821942bb
+
+# lint and format plugin-cloud
+fb7d1be2f3325d076b7c967b1730afcef37922c2
+
+# lint and format create-payload-app
+5fd3d430001efe86515262ded5e26f00c1451181

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -0,0 +1,47 @@
+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: Please add a link to a reproduction. See the fork [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md) for more information.
+    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: textarea
+    attributes:
+      label: Describe the Bug
+    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/BUG_REPORT.md

@@ -1,22 +0,0 @@
----
-name: Bug Report
-about: Create a bug report for Payload
-labels: 'possible-bug'
----
-
-# Bug Report
-
-<!--- Provide a general summary of the issue in the Title above -->
-
-## Steps to Reproduce
-
-<!--- Steps to reproduce this bug. Include any code, if relevant -->
-
-1.
-2.
-3.
-
-## Other Details
-
-<!--- Payload version, browser, etc -->
-<!--- Possible solution if you're familiar with the code -->

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Security Vulnerability
-    url: https://github.com/payloadcms/payload/blob/master/SECURITY.md
-    about: See instructions to privately disclose any security concerns
   - name: Feature Request
     url: https://github.com/payloadcms/payload/discussions
     about: Suggest an idea to improve Payload in our GitHub Discussions

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,15 +2,18 @@
 
 <!-- Please include a summary of the pull request and any related issues it fixes. Please also include relevant motivation and context. -->
 
-- [ ] I have read and understand the CONTRIBUTING.md document in this repository
+- [ ] I have read and understand the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository.
 
 ## Type of change
 
 <!-- Please delete options that are not relevant. -->
 
+- [ ] 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](../templates/) directory (does not affect core functionality)
+- [ ] Change to the [examples](../examples/) directory (does not affect core functionality)
 - [ ] This change requires a documentation update
 
 ## Checklist:

.github/reproduction-guide.md

@@ -0,0 +1,63 @@
+# Reproduction Guide
+
+1. [fork](https://github.com/payloadcms/payload/fork) this repo
+2. run `yarn` to install dependencies
+3. open up the `test/_community` directory
+4. add any necessary `collections/globals/fields` in this directory to recreate the issue you are experiencing
+5. run `yarn dev _community` to start the admin panel
+
+**NOTE:** The goal is to isolate the problem by reducing the number of `collections/globals/fields` you add to the `test/_community` folder. This folder is _not_ meant for you to copy your project into, but rather recreate the issue you are experiencing with minimal config.
+
+## Example test directory file tree
+
+```text
+.
+├── config.ts
+├── int.spec.ts
+├── e2e.spec.ts
+└── payload-types.ts
+```
+
+- `config.ts` - This is the _granular_ Payload config for testing. It should be as lightweight as possible. Reference existing configs for an example
+- `int.spec.ts` [Optional] - This is the test file run by jest. Any test file must have a `*int.spec.ts` suffix.
+- `e2e.spec.ts` [Optional] - This is the end-to-end test file that will load up the admin UI using the above config and run Playwright tests.
+- `payload-types.ts` - Generated types from `config.ts`. Generate this file by running `yarn dev:generate-types _community`.
+
+The directory split up in this way specifically to reduce friction when creating tests and to add the ability to boot up Payload with that specific config. You should modify the files in `test/_community` to get started.
+
+<br />
+
+## Testing is optional but encouraged
+
+An issue does not need to have failing tests — reproduction steps with your forked repo are enough at this point. Some people like to dive deeper and we want to give you the guidance/tools to do so. Read more below:
+
+### Running integration tests (Payload API tests)
+
+First install [Jest Runner for VSVode](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner).
+
+There are a couple ways run integration tests:
+
+- **Granularly** - you can run individual tests in vscode by installing the Jest Runner plugin and using that to run individual tests. Clicking the `debug` button will run the test in debug mode allowing you to set break points.
+
+  <img src="https://raw.githubusercontent.com/payloadcms/payload/main/packages/payload/src/admin/assets/images/github/int-debug.png" />
+
+- **Manually** - you can run all int tests in the `/test/_community/int.spec.ts` file by running the following command:
+
+  ```bash
+  yarn test:int _community
+  ```
+
+### Running E2E tests (Admin Panel UI tests)
+
+The easiest way to run E2E tests is to install
+
+- [Playwright Test for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)
+- [Playwright Runner](https://marketplace.visualstudio.com/items?itemName=ortoni.ortoni)
+
+Once they are installed you can open the `testing` tab in vscode sidebar and drill down to the test you want to run, i.e. `/test/_community/e2e.spec.ts`
+
+<img src="https://raw.githubusercontent.com/payloadcms/payload/main/packages/payload/src/admin/assets/images/github/e2e-debug.png" />
+
+#### Notes
+
+- It is recommended to add the test credentials (located in `test/credentials.ts`) to your autofill for `localhost:3000/admin` as this will be required on every nodemon restart. The default credentials are `dev@payloadcms.com` as email and `test` as password.

.github/workflows/main.yml

@@ -0,0 +1,242 @@
+name: build
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+  push:
+    branches: ['main']
+
+jobs:
+  core-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 25
+
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v3
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+            ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - run: pnpm install
+      - run: pnpm run build
+
+      - name: Cache build
+        uses: actions/cache@v3
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+  tests:
+    runs-on: ubuntu-latest
+    needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        database: [mongoose, postgres]
+    env:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: payloadtests
+
+    steps:
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v3
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Start PostgreSQL
+        uses: CasperWA/postgresql-action@v1.2
+        with:
+          postgresql version: '14'  # See https://hub.docker.com/_/postgres for available versions
+          postgresql db: ${{ env.POSTGRES_DB }}
+          postgresql user: ${{ env.POSTGRES_USER }}
+          postgresql password: ${{ env.POSTGRES_PASSWORD }}
+        if: matrix.database == 'postgres'
+
+      - run: sleep 30
+      - name: Configure PostgreSQL
+        run: |
+          psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "CREATE ROLE runner SUPERUSER LOGIN;"
+          psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "SELECT version();"
+          echo "POSTGRES_URL=postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" >> $GITHUB_ENV
+        if: matrix.database == 'postgres'
+
+      - name: Component Tests
+        run: pnpm test:components
+
+      - name: Integration Tests
+        run: pnpm test:int
+        env:
+          PAYLOAD_DATABASE: ${{ matrix.database }}
+          POSTGRES_URL: ${{ env.POSTGRES_URL }}
+
+  tests-e2e:
+    runs-on: ubuntu-latest
+    needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        part: [1/4, 2/4, 3/4, 4/4]
+
+    steps:
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v3
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: E2E Tests
+        run: pnpm test:e2e --part ${{ matrix.part }} --bail
+
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: test-results
+          path: test-results/
+          retention-days: 1
+
+  tests-type-generation:
+    runs-on: ubuntu-latest
+    needs: core-build
+
+    steps:
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v3
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Generate Payload Types
+        run: pnpm dev:generate-types fields
+
+      - 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:
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v3
+        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:
+          - plugin-cloud
+          - create-payload-app
+
+    steps:
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v3
+        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

.github/workflows/tests.yml

@@ -1,87 +0,0 @@
-name: build
-
-on:
-  pull_request:
-    types: [opened, reopened, edited, synchronize]
-  push:
-    branches: ['master']
-
-jobs:
-  build_yarn:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [14.x, 16.x, 18.x]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-        registry-url: https://registry.npmjs.org
-        scope: '@payloadcms'
-        always-auth: true
-    - name: Cache node modules
-      uses: actions/cache@v1
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-build-${{ env.cache-name }}-
-          ${{ runner.os }}-build-
-          ${{ runner.os }}-
-    - run: yarn
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-    - run: yarn build
-
-    - name: Component Tests
-      run: yarn test:components
-    - name: Integration Tests
-      run: yarn test:int
-
-    - name: Generate Payload Types
-      run: yarn dev:generate-types fields
-
-    - name: Generate GraphQL schema file
-      run: yarn dev:generate-graphql-schema
-
-    - name: Install Playwright Browsers
-      run: npx playwright install --with-deps
-    - name: E2E Tests
-      run: yarn test:e2e --bail
-
-    # - uses: actions/upload-artifact@v2
-    #   if: always()
-    #   with:
-    #     name: playwright-report
-    #     path: playwright-report/
-    #     retention-days: 30
-  install_npm:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [16.x]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-        registry-url: https://registry.npmjs.org
-        scope: '@payloadcms'
-        always-auth: true
-    - name: Cache node modules
-      uses: actions/cache@v1
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-npm-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-npm-${{ env.cache-name }}-
-          ${{ runner.os }}-npm-
-          ${{ runner.os }}-
-    - run: npm install --legacy-peer-deps
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -2,11 +2,16 @@ coverage
 package-lock.json
 dist
 .idea
+test-results
+.devcontainer
+/migrations
 
-# Created by https://www.gitignore.io/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
+# 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
 
 ### macOS ###
-*.DS_Store
+# General
+.DS_Store
 .AppleDouble
 .LSOverride
 
@@ -29,6 +34,10 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
 ### Node ###
 # Logs
 logs
@@ -36,6 +45,11 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 pids
@@ -48,11 +62,12 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+*.lcov
 
 # nyc test coverage
 .nyc_output
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
 # Bower dependency directory (https://bower.io/)
@@ -61,15 +76,18 @@ bower_components
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
+# Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
 
 # Dependency directories
 node_modules/
 jspm_packages/
 
-# Typescript v1 declaration files
-typings/
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
 
 # Optional npm cache directory
 .npm
@@ -77,6 +95,15 @@ typings/
 # Optional eslint cache
 .eslintcache
 
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
 # Optional REPL history
 .node_repl_history
 
@@ -86,34 +113,87 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-# Yarn Berry
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
 .pnp.*
 
-# dotenv environment variables file
-.env
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
 
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
 
 ### SublimeText ###
-# cache files for sublime text
+# Cache files for Sublime Text
 *.tmlanguage.cache
 *.tmPreferences.cache
 *.stTheme.cache
 
-# workspace files are user-specific
+# Workspace files are user-specific
 *.sublime-workspace
 
-# project files should be checked into the repository, unless a significant
-# proportion of contributors will probably not be using SublimeText
+# Project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using Sublime Text
 # *.sublime-project
 
-# sftp configuration file
+# SFTP configuration file
 sftp-config.json
+sftp-config-alt*.json
 
 # Package control specific files
 Package Control.last-run
@@ -133,46 +213,77 @@ GitHub.sublime-settings
 
 ### VisualStudioCode ###
 .vscode/*
+!.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
 .history
+.ionide
 
 ### WebStorm ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
-# User-specific stuff:
+# User-specific stuff
 .idea/**/workspace.xml
 .idea/**/tasks.xml
-.idea/dictionaries
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
 
-# Sensitive or high-churn files:
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
 .idea/**/dataSources/
 .idea/**/dataSources.ids
-.idea/**/dataSources.xml
 .idea/**/dataSources.local.xml
 .idea/**/sqlDataSources.xml
 .idea/**/dynamic.xml
 .idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
 
-# Gradle:
+# Gradle
 .idea/**/gradle.xml
 .idea/**/libraries
 
-# CMake
-cmake-build-debug/
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
 
-# Mongo Explorer plugin:
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
 .idea/**/mongoSettings.xml
 
-## File-based project format:
+# File-based project format
 *.iws
 
-## Plugin-specific files:
-
 # IntelliJ
-/out/
+out/
 
 # mpeltonen/sbt-idea plugin
 .idea_modules/
@@ -183,8 +294,8 @@ atlassian-ide-plugin.xml
 # Cursive Clojure plugin
 .idea/replstate.xml
 
-# Ruby plugin and RubyMine
-/.rakeTasks
+# SonarLint plugin
+.idea/sonarlint/
 
 # Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml
@@ -192,6 +303,12 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
 ### WebStorm Patch ###
 # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
 
@@ -201,16 +318,43 @@ fabric.properties
 # *.ipr
 
 # Sonarlint plugin
-.idea/sonarlint
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
 
 ### Windows ###
 # Windows thumbnail cache files
 Thumbs.db
+Thumbs.db:encryptable
 ehthumbs.db
 ehthumbs_vista.db
 
+# Dump file
+*.stackdump
+
 # Folder config file
-Desktop.ini
+[Dd]esktop.ini
 
 # Recycle Bin used on file shares
 $RECYCLE.BIN/
@@ -218,26 +362,13 @@ $RECYCLE.BIN/
 # Windows Installer files
 *.cab
 *.msi
+*.msix
 *.msm
 *.msp
 
 # Windows shortcuts
 *.lnk
 
-# End of https://www.gitignore.io/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
 
-# Ignore all uploads
-demo/upload
-demo/media
-demo/files
-
-# Ignore build folder
-build
-
-# Ignore built components
-components/index.js
-components/styles.css
-
-# Ignore generated
-demo/generated-types.ts
-demo/generated-schema.graphql
+/build

.husky/pre-commit

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

.node-version

@@ -1 +1 @@
-v16.14.2
+v18.17.1

.npmrc

@@ -0,0 +1,2 @@
+symlink=true
+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 @@
-v16.14.2
+v18.17.1

.prettierignore

@@ -0,0 +1,11 @@
+.tmp
+**/.git
+**/.hg
+**/.pnp.*
+**/.svn
+**/.yarn/**
+**/build
+**/dist/**
+**/node_modules
+**/temp
+**/docs/**

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "semi": false
+}

.release-it.json

@@ -1,4 +1,5 @@
 {
+  "verbose": true,
   "git": {
     "commitMessage": "chore(release): v${version}",
     "requireCleanWorkingDir": true
@@ -10,7 +11,7 @@
     "skipChecks": true
   },
   "hooks": {
-    "before:init": ["yarn", "yarn clean", "yarn test"]
+    "before:init": ["pnpm i", "pnpm clean", "pnpm test"]
   },
   "plugins": {
     "@release-it/conventional-changelog": {

.release-it.pre.json

@@ -1,4 +1,5 @@
 {
+  "verbose": true,
   "git": {
     "requireCleanWorkingDir": false,
     "commit": false,
@@ -6,14 +7,14 @@
     "tag": false
   },
   "github": {
-    "release": false
+    "release": true
   },
   "npm": {
     "skipChecks": true,
     "tag": "canary"
   },
   "hooks": {
-    "before:init": ["yarn", "yarn clean", "yarn test"]
+    "before:init": ["pnpm i", "pnpm clean", "pnpm test"]
   },
   "plugins": {
     "@release-it/conventional-changelog": {

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}

.vscode/launch.json

@@ -1,21 +1,146 @@
 {
   // Use IntelliSense to learn about possible attributes.
   // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
   "configurations": [
     {
-      "type": "node",
+      "command": "pnpm run dev _community",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Community",
       "request": "launch",
-      "name": "Launch Program",
-      "runtimeArgs": [
-        "-r",
-        "ts-node/register"
-      ],
-      "args": [
-        "${workspaceFolder}/test/dev.ts",
-        "fields"
-      ]
+      "type": "node-terminal"
     },
-  ]
+    {
+      "command": "pnpm run dev fields",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Fields",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "pnpm run dev:postgres fields",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Postgres",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "pnpm run dev versions",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Versions",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "PAYLOAD_BUNDLER=vite pnpm run dev fields",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Fields (Vite)",
+      "request": "launch",
+      "type": "node-terminal",
+      "env": {
+        "NODE_ENV": "production"
+      }
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts build",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/fields/config.ts",
+        "PAYLOAD_BUNDLER": "vite",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+      },
+      "name": "Build CLI - Vite",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts build",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/fields/config.ts",
+        "PAYLOAD_ANALYZE_BUNDLE": "true",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+      },
+      "name": "Build CLI - Webpack",
+      "outputCapture": "std",
+      "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": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "postgres",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - status",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:create yass",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "postgres",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - create",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:down",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "mongoose",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - down",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:reset",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "mongoose",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - reset",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:refresh",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "mongoose",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - refresh",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ],
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0"
 }

.vscode/settings.json

@@ -0,0 +1,39 @@
+{
+  "npm.packageManager": "pnpm",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "editor.formatOnSaveMode": "file",
+  // 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"]
+}

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing to Payload
+
+Below you'll find a set of guidelines for how to contribute to Payload.
+
+## Opening issues
+
+Before you submit an issue, please check all existing [open and closed issues](https://github.com/payloadcms/payload/issues) to see if your issue has previously been resolved or is already known. If there is already an issue logged, feel free to upvote it by adding a :thumbsup: [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). If you would like to submit a new issue, please fill out our Issue Template to the best of your ability so we can accurately understand your report.
+
+## Security issues & vulnerabilities
+
+If you come across an issue related to security, or a potential attack vector within Payload or one of its dependencies, please DO NOT create a publicly viewable issue. Instead, please contact us directly at [`dev@payloadcms.com`](mailto:dev@payloadcms.com). We will do everything we can to respond to the issue as soon as possible.
+
+If you find a vulnerability within the core Payload repository, and we determine that it is remediable and of significant nature, we will be happy to pay you a reward for your findings and diligence. [`Contact us`](mailto:dev@payloadcms.com) to find out more.
+
+## Documentation edits
+
+Payload documentation can be found directly within its codebase and you can feel free to make changes / improvements to any of it through opening a PR. We utilize these files directly in our website and will periodically deploy documentation updates as necessary.
+
+## Building additional features
+
+If you're an incredibly awesome person and want to help us make Payload even better through new features or additions, we would be thrilled to work with you.
+
+## Design Contributions
+
+When it comes to design-related changes or additions, it's crucial for us to ensure a cohesive user experience and alignment with our broader design vision. Before embarking on any implementation that would affect the design or UI/UX, we ask that you **first share your design proposal** with us for review and approval.
+
+Our design review ensures that proposed changes fit seamlessly with other components, both existing and planned. This step is meant to prevent unintentional design inconsistencies and to save you from investing time in implementing features that might need significant design alterations later.
+
+### Before Starting
+
+To help us work on new features, you can create a new feature request post in [GitHub Discussion](https://github.com/payloadcms/payload/discussions) or discuss it in our [Discord](https://discord.com/invite/payload). New functionality often has large implications across the entire Payload repo, so it is best to discuss the architecture and approach before starting work on a pull request.
+
+### Code
+
+Most new functionality should keep testing in mind. With 1.0, testability of new features has been vastly improved. All top-level directories within the `test/` directory are for testing a specific category: `fields`, `collections`, etc.
+
+If it makes sense to add your feature to an existing test directory, please do so.
+
+A typical directory with `test/` will be structured like this:
+
+```text
+.
+├── config.ts
+├── int.spec.ts
+├── e2e.spec.ts
+└── payload-types.ts
+```
+
+- `config.ts` - This is the _granular_ Payload config for testing. It should be as lightweight as possible. Reference existing configs for an example
+- `int.spec.ts` - This is the test file run by jest. Any test file must have a `*int.spec.ts` suffix.
+- `e2e.spec.ts` - This is the end-to-end test file that will load up the admin UI using the above config and run Playwright tests. These tests are typically only needed if a large change is being made to the Admin UI.
+- `payload-types.ts` - Generated types from `config.ts`. Generate this file by running `pnpm dev:generate-types my-test-dir`.
+
+The directory split up in this way specifically to reduce friction when creating tests and to add the ability to boot up Payload with that specific config.
+
+The following command will start Payload with your config: `pnpm dev my-test-dir`. This command will start up Payload using your config and refresh a test database on every restart.
+
+By default, it will automatically log you in 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`.
+
+If you wish to use to your own Mongo database for the `test` directory instead of using the in memory database, all you need to do is add the following env vars to the `test/dev.ts` file:
+
+- `process.env.NODE_ENV`
+- `process.env.PAYLOAD_TEST_MONGO_URL`
+- Simply set `process.env.NODE_ENV` to `test` and set `process.env.PAYLOAD_TEST_MONGO_URL` to your mongo url e.g. `mongodb://127.0.0.1/your-test-db`.
+
+NOTE: It is recommended to add the test credentials (located in `test/credentials.ts`) to your autofill for `localhost:3000/admin` as this will be required on every nodemon restart. The default credentials are `dev@payloadcms.com` as E-Mail and `test` as password.
+
+### Commits
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. Please follow this format when creating commits. Here are some examples:
+
+- `feat: adds new feature`
+- `fix: fixes bug`
+- `docs: adds documentation`
+- `chore: does chore`
+
+Here's a breakdown of the format. At the top-level, we use the following types to categorize our commits:
+
+- `feat`: new feature that adds functionality. These are automatically added to the changelog when creating new releases.
+- `fix`: a fix to an existing feature. These are automatically added to the changelog when creating new releases.
+- `docs`: changes to [docs](./docs) only. These do not appear in the changelog.
+- `chore`: changes to code that is neither a fix nor a feature (e.g. refactoring, adding tests, etc.). These do not appear in the changelog.
+
+If you are committing to [templates](./templates) or [examples](./examples), use the `chore` type with the proper scope, like this:
+
+- `chore(templates): adds feature to template`
+- `chore(examples): fixes bug in example`
+
+## Pull Requests
+
+For all Pull Requests, you should be extremely descriptive about both your problem and proposed solution. If there are any affected open or closed issues, please leave the issue number in your PR message.

ISSUE_GUIDE.md

@@ -0,0 +1,69 @@
+# Reporting an issue
+
+To report an issue, please follow the steps below:
+
+1. Fork this repository
+2. Add necessary collections/globals/fields to the `test/_community` directory to recreate the issue you are experiencing
+3. Create an issue and add a link to your forked repo
+
+**The goal is to isolate the problem by reducing the number of fields/collections you add to the test/\_community folder. This folder is not meant for you to copy your project into, but to recreate the issue you are experiencing with minimal config.**
+
+## Test directory file tree explanation
+
+```text
+.
+├── config.ts
+├── int.spec.ts
+├── e2e.spec.ts
+└── payload-types.ts
+```
+
+- `config.ts` - This is the _granular_ Payload config for testing. It should be as lightweight as possible. Reference existing configs for an example
+- `int.spec.ts` [Optional] - This is the test file run by jest. Any test file must have a `*int.spec.ts` suffix.
+- `e2e.spec.ts` [Optional] - This is the end-to-end test file that will load up the admin UI using the above config and run Playwright tests.
+- `payload-types.ts` - Generated types from `config.ts`. Generate this file by running `pnpm dev:generate-types _community`.
+
+The directory split up in this way specifically to reduce friction when creating tests and to add the ability to boot up Payload with that specific config. You should modify the files in `test/_community` to get started.
+
+## How to start test collection admin UI
+
+To start the admin panel so you can manually recreate your issue, you can run the following command:
+
+```bash
+# This command will start up Payload using your config
+# NOTE: it will wipe the test database on restart
+pnpm dev _community
+```
+
+## Testing is optional but encouraged
+
+An issue does not need to have failing tests — reproduction steps with your forked repo are enough at this point. Some people like to dive deeper and we want to give you the guidance/tools to do so. Read more below.
+
+### How to run integration tests (Payload API tests)
+
+There are a couple ways to do this:
+
+- **Granularly** - you can run individual tests in vscode by installing the Jest Runner plugin and using that to run individual tests. Clicking the `debug` button will run the test in debug mode allowing you to set break points.
+
+  <img src="https://raw.githubusercontent.com/payloadcms/payload/main/src/admin/assets/images/github/int-debug.png" />
+
+- **Manually** - you can run all int tests in the `/test/_community/int.spec.ts` file by running the following command:
+
+  ```bash
+  pnpm test:int _community
+  ```
+
+### How to run E2E tests (Admin Panel UI tests)
+
+The easiest way to run E2E tests is to install
+
+- [Playwright Test for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)
+- [Playwright Runner](https://marketplace.visualstudio.com/items?itemName=ortoni.ortoni)
+
+Once they are installed you can open the `testing` tab in vscode sidebar and drill down to the test you want to run, i.e. `/test/_community/e2e.spec.ts`
+
+<img src="https://raw.githubusercontent.com/payloadcms/payload/main/src/admin/assets/images/github/e2e-debug.png" />
+
+#### Notes
+
+- It is recommended to add the test credentials (located in `test/credentials.ts`) to your autofill for `localhost:3000/admin` as this will be required on every nodemon restart. The default credentials are `dev@payloadcms.com` as email and `test` as password.

README.md

@@ -1,38 +1,14 @@
-<p style="border: none; margin-bottom:0; padding-bottom: 0;" align="center">
-  <a href="https://payloadcms.com">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/payloadcms/payload/master/src/admin/assets/images/payload-logo-light.svg">
-      <img width="350" alt="payload cms logo" src="https://raw.githubusercontent.com/payloadcms/payload/master/src/admin/assets/images/payload-logo-dark.svg">
-    </picture>
-  </a>
-</p>
-
-<h3 align="center">The most powerful TypeScript CMS</h3>
-<p align="center">Code-first Headless CMS that bridges the gap between CMS and application framework</p>
-
-<h3 align="center">
-  <a target="_blank" href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the docs</strong></a>
-  ·
-  <a target="_blank" href="https://demo.payloadcms.com/" rel="dofollow"><strong>Try Live Demo</strong></a>
-  <br />
-</h3>
-
+<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 />
-
-<p align="center">
-  <a href="https://opensource.org/licenses/MIT">
-    <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" />
-  </a>
-  &nbsp;
+<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/tests.yml?style=flat-square">
+    <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/payloadcms/payload/main.yml?style=flat-square">
   </a>
   &nbsp;
-  <a href="https://github.com/payloadcms/payload/commits">
-    <img src="https://img.shields.io/github/commit-activity/m/payloadcms/payload?style=flat-square" alt="git commit activity"/>
-  </a>
-  &nbsp;
-  <a href="https://discord.com/invite/r6sCXqVk3v">
+  <a href="https://discord.gg/payload">
     <img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da&style=flat-square" />
   </a>
   &nbsp;
@@ -41,28 +17,61 @@
   </a>
   &nbsp;
   <a href="https://twitter.com/payloadcms">
-    <img src="https://img.shields.io/badge/follow-payloadcms-1DA1F2?logo=twitter&style=flat-square" alt="Payload CMS Twitter" />
+    <img src="https://img.shields.io/badge/follow-payloadcms-1DA1F2?logo=twitter&style=flat-square" alt="Payload Twitter" />
   </a>
 </p>
+<hr/>
+<h4>
+<a target="_blank" href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the Docs</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://payloadcms.com/community-help" rel="dofollow"><strong>Community Help</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://demo.payloadcms.com/" rel="dofollow"><strong>Try Live Demo</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://github.com/payloadcms/payload/discussions/1539" rel="dofollow"><strong>Roadmap</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://www.g2.com/products/payload-cms/reviews#reviews" rel="dofollow"><strong>View G2 Reviews</strong></a>
+</h4>
+<hr/>
 
-<br />
+> [!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>.
 
-<a href="https://payloadcms.com">
-  <img src="https://cms.payloadcms.com/media/payload-github-header.jpg" alt="Payload headless CMS Admin panel built with React" />
-</a>
+<h3>Benefits over a regular CMS</h3>
+<ul>
+  <li>Don’t hit some third-party SaaS API, hit your own API</li>
+  <li>Use your own database and own your data</li>
+  <li>It's just Express - do what you want outside of Payload</li>
+  <li>No need to learn how Payload works - if you know JS, you know Payload</li>
+  <li>No vendor lock-in</li>
+  <li>Avoid microservices hell - get everything (even auth) in one place</li>
+  <li>Never touch ancient WP code again</li>
+  <li>Build faster, never hit a roadblock</li>
+  <li>Both admin and backend are 100% extensible</li>
+</ul>
 
-<br />
+## ☁️ Deploy instantly with Payload Cloud.
 
-## ⭐ Why Payload?
+Create a cloud account, connect your GitHub, and [deploy in minutes](https://payloadcms.com/new).
 
-Payload is a CMS that has been designed for developers from the ground up to deliver them what they need to build great digital products. If you know JavaScript, you know Payload. It's a _code-first_ CMS, which allows us to do a lot of things right:
+## 🚀 Get started by self-hosting completely free, forever.
 
-- Payload gives you everything you need, but then steps back and lets you build what you want in JavaScript or TypeScript - with no unnecessary complexity brought by GUIs. You'll understand how your CMS works because you will have written it exactly how you want it.
-- Bring your own Express server and do whatever you need on top of Payload. Payload doesn't impose anything on you or your app.
-- Completely control the Admin panel by using your own React components. Swap out fields or even entire views with ease.
-- Use your data however and wherever you need thanks to auto-generated, yet fully extensible REST, GraphQL, and Local Node APIs.
+Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation).
 
-<a target="_blank" href="https://payloadcms.com/" rel="dofollow"><strong>Read more on our website</strong></a>
+```text
+npx create-payload-app
+```
+
+Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
+
+## 🖱️ One-click templates
+
+Jumpstart your next project by starting with a pre-made template. These are production-ready, end-to-end solutions designed to get you to market as fast as possible.
+
+### [🛒 E-Commerce](https://github.com/payloadcms/payload/tree/main/templates/ecommerce)
+
+Eliminate the need to combine Shopify and a CMS, and instead do it all with Payload + Stripe. Comes with a beautiful, fully functional front-end complete with shopping cart, checkout, orders, and much more.
+
+### [🌐 Website](https://github.com/payloadcms/payload/tree/main/templates/website)
+
+Build any kind of website, blog, or portfolio from small to enterprise. Comes with a beautiful, fully functional front-end complete with posts, projects, comments, and much more.
+
+We're constantly adding more templates to our [Templates Directory](https://github.com/payloadcms/payload/tree/main/templates). If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find.
+
+- [Official Templates](https://github.com/payloadcms/payload/tree/main/templates)
+- [Community Templates](https://github.com/topics/payload-template)
 
 ## ✨ Features
 
@@ -85,33 +94,40 @@ Payload is a CMS that has been designed for developers from the ground up to del
 - Highly secure thanks to HTTP-only cookies, CSRF protection, and more
 
 <a target="_blank" href="https://github.com/payloadcms/payload/discussions"><strong>Request Feature</strong></a>
-## 🚀 Quick Start
-
-Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation).
-
-From there, the easiest way to get started with Payload is to use the `create-payload-app` package:
-
-```text
-npx create-payload-app
-```
-
-Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
 
 ## 🗒️ Documentation
 
 Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
 
+Migrating from v1 to v2? Check out the [2.0 Release Notes](https://github.com/payloadcms/payload/releases/tag/v2.0.0) on how to do it.
+
 ## 🙋 Contributing
 
-If you want to add contributions to this repository, please follow the instructions in [contributing.md](./contributing.md).
+If you want to add contributions to this repository, please follow the instructions in [contributing.md](./CONTRIBUTING.md).
+
+## 📚 Examples
+
+The [Examples Directory](./examples) is a great resource for learning how to setup Payload in a variety of different ways, but you can also find great examples in our blog and throughout our social media.
+
+- [Examples Directory](./examples)
+- [Payload Blog](https://payloadcms.com/blog)
+- [Payload YouTube](https://www.youtube.com/@payloadcms)
+
+## 🔌 Plugins
+
+Payload is highly extensible and allows you to install or distribute plugins that add or remove functionality. There are both officially-supported and community-supported plugins available. If you maintain your own plugin, consider adding the `payload-plugin` topic to your GitHub repository for others to find.
+
+- [Official Plugins](https://github.com/orgs/payloadcms/repositories?q=topic%3Apayload-plugin)
+- [Community Plugins](https://github.com/topics/payload-plugin)
 
 ## 🚨 Need help?
 
-There are lots of good conversations and resources in our Github Discussions board & our Discord Server. If you're struggling with something, chances are, someone's already solved what you're up against. :point_down:
+There are lots of good conversations and resources in our Github Discussions board and our Discord Server. If you're struggling with something, chances are, someone's already solved what you're up against. :point_down:
 
 - [GitHub Discussions](https://github.com/payloadcms/payload/discussions)
 - [GitHub Issues](https://github.com/payloadcms/payload/issues)
 - [Discord](https://t.co/30APlsQUPB)
+- [Community Help](https://payloadcms.com/community-help)
 
 ## ⭐ Like what we're doing? Give us a star
 

auth.d.ts

@@ -1 +0,0 @@
-export * from './dist/auth';

auth.js

@@ -1 +0,0 @@
-module.exports = require('./dist/auth');

bin.js

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('./dist/bin');

components/elements.js

@@ -1,5 +0,0 @@
-exports.Button = require('../dist/admin/components/elements/Button').default;
-exports.Card = require('../dist/admin/components/elements/Card').default;
-exports.Eyebrow = require('../dist/admin/components/elements/Eyebrow').default;
-exports.Nav = require('../dist/admin/components/elements/Nav').default;
-exports.Gutter = require('../dist/admin/components/elements/Gutter').Gutter;

components/elements.ts

@@ -1,5 +0,0 @@
-export { default as Button } from '../dist/admin/components/elements/Button';
-export { default as Card } from '../dist/admin/components/elements/Card';
-export { default as Eyebrow } from '../dist/admin/components/elements/Eyebrow';
-export { default as Nav } from '../dist/admin/components/elements/Nav';
-export { Gutter } from '../dist/admin/components/elements/Gutter';

components/fields/Array.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Array/types';

components/fields/Blocks.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Blocks/types';

components/fields/Cell.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/views/collections/List/Cell/types';

components/fields/Checkbox.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Checkbox/types';

components/fields/Code.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Code/types';

components/fields/DateTime.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/DateTime/types';

components/fields/Email.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Email/types';

components/fields/Group.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Group/types';

components/fields/Json.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/JSON/types';

components/fields/Number.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Number/types';

components/fields/Password.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Password/types';

components/fields/RadioGroup/RadioInput.ts

@@ -1 +0,0 @@
-export type { Props } from '../../../dist/admin/components/forms/field-types/RadioGroup/RadioInput/types';

components/fields/RadioGroup/index.ts

@@ -1 +0,0 @@
-export type { Props } from '../../../dist/admin/components/forms/field-types/RadioGroup/types';

components/fields/Relationship.ts

@@ -1 +0,0 @@
-export type { Props, Option, ValueWithRelation } from '../../dist/admin/components/forms/field-types/Relationship/types';

components/fields/RichText.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/RichText/types';

components/fields/Row.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Row/types';

components/fields/Select.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Select/types';

components/fields/Text.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Text/types';

components/fields/Textarea.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Textarea/types';

components/fields/Upload.ts

@@ -1 +0,0 @@
-export type { Props } from '../../dist/admin/components/forms/field-types/Upload/types';

components/forms.js

@@ -1,42 +0,0 @@
-exports.useForm = require('../dist/admin/components/forms/Form/context').useForm;
-
-/**
- * @deprecated useWatchForm is no longer preferred. If you need all form fields, prefer `useAllFormFields`.
- */
-exports.useWatchForm = require('../dist/admin/components/forms/Form/context').useWatchForm;
-
-exports.useFormFields = require('../dist/admin/components/forms/Form/context').useFormFields;
-
-exports.useAllFormFields = require('../dist/admin/components/forms/Form/context').useAllFormFields;
-
-exports.useFormSubmitted = require('../dist/admin/components/forms/Form/context').useFormSubmitted;
-
-exports.useFormProcessing = require('../dist/admin/components/forms/Form/context').useFormProcessing;
-
-exports.useFormModified = require('../dist/admin/components/forms/Form/context').useFormModified;
-
-exports.useField = require('../dist/admin/components/forms/useField').default;
-
-/**
- * @deprecated This method is now called useField. The useFieldType alias will be removed in an upcoming version.
- */
-exports.useFieldType = require('../dist/admin/components/forms/useField').default;
-
-exports.Form = require('../dist/admin/components/forms/Form').default;
-
-exports.Text = require('../dist/admin/components/forms/field-types/Text').default;
-exports.TextInput = require('../dist/admin/components/forms/field-types/Text/Input').default;
-
-exports.Group = require('../dist/admin/components/forms/field-types/Group').default;
-
-exports.Select = require('../dist/admin/components/forms/field-types/Select').default;
-exports.SelectInput = require('../dist/admin/components/forms/field-types/Select/Input').default;
-
-exports.Checkbox = require('../dist/admin/components/forms/field-types/Checkbox').default;
-exports.Submit = require('../dist/admin/components/forms/Submit').default;
-exports.Label = require('../dist/admin/components/forms/Label').default;
-
-exports.reduceFieldsToValues = require('../dist/admin/components/forms/Form/reduceFieldsToValues').default;
-exports.getSiblingData = require('../dist/admin/components/forms/Form/getSiblingData').default;
-
-exports.withCondition = require('../dist/admin/components/forms/withCondition').default;

components/forms.ts

@@ -1,38 +0,0 @@
-export {
-  useForm,
-  /**
-   * @deprecated useWatchForm is no longer preferred. If you need all form fields, prefer `useAllFormFields`.
-   */
-  useWatchForm,
-  useFormFields,
-  useAllFormFields,
-  useFormSubmitted,
-  useFormProcessing,
-  useFormModified,
-} from '../dist/admin/components/forms/Form/context';
-
-export { default as useField } from '../dist/admin/components/forms/useField';
-
-/**
- * @deprecated This method is now called useField. The useFieldType alias will be removed in an upcoming version.
- */
-export { default as useFieldType } from '../dist/admin/components/forms/useField';
-
-export { default as Form } from '../dist/admin/components/forms/Form';
-
-export { default as Text } from '../dist/admin/components/forms/field-types/Text';
-export { default as TextInput } from '../dist/admin/components/forms/field-types/Text/Input';
-
-export { default as Group } from '../dist/admin/components/forms/field-types/Group';
-
-export { default as Select } from '../dist/admin/components/forms/field-types/Select';
-export { default as SelectInput } from '../dist/admin/components/forms/field-types/Select/Input';
-
-export { default as Checkbox } from '../dist/admin/components/forms/field-types/Checkbox';
-export { default as Submit } from '../dist/admin/components/forms/Submit';
-export { default as Label } from '../dist/admin/components/forms/Label';
-
-export { default as reduceFieldsToValues } from '../dist/admin/components/forms/Form/reduceFieldsToValues';
-export { default as getSiblingData } from '../dist/admin/components/forms/Form/getSiblingData';
-
-export { default as withCondition } from '../dist/admin/components/forms/withCondition';

components/hooks.js

@@ -1 +0,0 @@
-exports.useStepNav = require('../dist/admin/components/elements/StepNav').useStepNav;

components/hooks.ts

@@ -1 +0,0 @@
-export { useStepNav } from '../dist/admin/components/elements/StepNav';

components/icons.js

@@ -1,2 +0,0 @@
-exports.Chevron = require('../dist/admin/components/icons/Chevron').default;
-exports.X = require('../dist/admin/components/icons/X').default;

components/icons.ts

@@ -1,2 +0,0 @@
-export { default as Chevron } from '../dist/admin/components/icons/Chevron';
-export { default as X } from '../dist/admin/components/icons/X';

components/index.ts

@@ -1 +0,0 @@
-export * from '../dist/admin/components';

components/preferences.js

@@ -1 +0,0 @@
-exports.usePreferences = require('../dist/admin/components/utilities/Preferences').usePreferences;

components/preferences.ts

@@ -1 +0,0 @@
-export { usePreferences } from '../dist/admin/components/utilities/Preferences';

components/rich-text.js

@@ -1,3 +0,0 @@
-exports.LeafButton = require('../dist/admin/components/forms/field-types/RichText/leaves/Button').default;
-exports.ElementButton = require('../dist/admin/components/forms/field-types/RichText/elements/Button').default;
-exports.toggleElement = require('../dist/admin/components/forms/field-types/RichText/elements/toggle').default;

components/rich-text.ts

@@ -1,3 +0,0 @@
-export { default as LeafButton } from '../dist/admin/components/forms/field-types/RichText/leaves/Button';
-export { default as ElementButton } from '../dist/admin/components/forms/field-types/RichText/elements/Button';
-export { default as toggleElement } from '../dist/admin/components/forms/field-types/RichText/elements/toggle';

components/templates.js

@@ -1,2 +0,0 @@
-exports.DefaultTemplate = require('../dist/admin/components/templates/Default').default;
-exports.MinimalTemplate = require('../dist/admin/components/templates/Minimal').default;

components/templates.ts

@@ -1,2 +0,0 @@
-export { default as DefaultTemplate } from '../dist/admin/components/templates/Default';
-export { default as MinimalTemplate } from '../dist/admin/components/templates/Minimal';

components/utilities.js

@@ -1,6 +0,0 @@
-exports.Meta = require('../dist/admin/components/utilities/Meta').default;
-exports.useLocale = require('../dist/admin/components/utilities/Locale').useLocale;
-exports.useDocumentInfo = require('../dist/admin/components/utilities/DocumentInfo').useDocumentInfo;
-exports.useConfig = require('../dist/admin/components/utilities/Config').useConfig;
-exports.useAuth = require('../dist/admin/components/utilities/Auth').useAuth;
-exports.useEditDepth = require('../dist/admin/components/utilities/EditDepth').useEditDepth;

components/utilities.ts

@@ -1,6 +0,0 @@
-export { default as Meta } from '../dist/admin/components/utilities/Meta';
-export { useLocale } from '../dist/admin/components/utilities/Locale';
-export { useDocumentInfo } from '../dist/admin/components/utilities/DocumentInfo';
-export { useConfig } from '../dist/admin/components/utilities/Config';
-export { useAuth } from '../dist/admin/components/utilities/Auth';
-export { useEditDepth } from '../dist/admin/components/utilities/EditDepth';

components/views/Cell.js

@@ -1 +0,0 @@
-exports.Cell = require('../../dist/admin/components/views/collections/List/Cell').default;

components/views/Cell.ts

@@ -1,2 +0,0 @@
-export { default as Cell } from '../../dist/admin/components/views/collections/List/Cell';
-export type { Props } from '../../dist/admin/components/views/collections/List/Cell/types';

components/views/Dashboard.js

@@ -1 +0,0 @@
-exports.Dashboard = required('../../dist/admin/components/views/Dashboard/Default').default;

components/views/Dashboard.ts

@@ -1,3 +0,0 @@
-export { default as Dashboard } from '../../dist/admin/components/views/Dashboard/Default';
-
-export type { Props } from '../../dist/admin/components/views/Dashboard/types';

components/views/Edit.js

@@ -1 +0,0 @@
-exports.Edit = require('../../dist/admin/components/views/collections/Edit/Default').default;

components/views/Edit.ts

@@ -1,2 +0,0 @@
-export { default as Edit } from '../../dist/admin/components/views/collections/Edit/Default';
-export type { Props } from '../../dist/admin/components/views/collections/Edit/types';

components/views/List.js

@@ -1 +0,0 @@
-exports.List = require('../../dist/admin/components/views/collections/List/Default').default;

components/views/List.ts

@@ -1,2 +0,0 @@
-export { default as List } from '../../dist/admin/components/views/collections/List/Default';
-export type { Props } from '../../dist/admin/components/views/collections/Edit/types';

config.d.ts

@@ -1,2 +0,0 @@
-export { buildConfig } from './dist/config/build';
-export * from './dist/config/types';

config.js

@@ -1 +0,0 @@
-exports.buildConfig = require('./dist/config/build').buildConfig;

contributing.md

@@ -1,58 +0,0 @@
-# Contributing to Payload CMS
-
-Below you'll find a set of guidelines for how to contribute to Payload CMS.
-
-## Opening issues
-
-Before you submit an issue, please check all existing [open and closed issues](https://github.com/payloadcms/payload/issues) to see if your issue has previously been resolved or is already known. If there is already an issue logged, feel free to upvote it by adding a :thumbsup: [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). If you would like to submit a new issue, please fill out our Issue Template to the best of your ability so we can accurately understand your report.
-
-## Security issues & vulnerabilities
-
-If you come across an issue related to security, or a potential attack vector within Payload or one of its dependencies, please DO NOT create a publicly viewable issue. Instead, please contact us directly at [`dev@payloadcms.com`](mailto:dev@payloadcms.com). We will do everything we can to respond to the issue as soon as possible.
-
-If you find a vulnerability within the core Payload repository, and we determine that it is remediable and of significant nature, we will be happy to pay you a reward for your findings and diligence. [`Contact us`](mailto:dev@payloadcms.com) to find out more.
-
-## Documentation edits
-
-Payload documentation can be found directly within its codebase and you can feel free to make changes / improvements to any of it through opening a PR. We utilize these files directly in our website and will periodically deploy documentation updates as necessary.
-
-## Building additional features
-
-If you're an incredibly awesome person and want to help us make Payload even better through new features or additions, we would be thrilled to work with you.
-
-### Before Starting
-
-To help us work on new features, you can create a new feature request post in [GitHub Discussion](https://github.com/payloadcms/payload/discussions) or discuss it in our [Discord](https://discord.com/invite/r6sCXqVk3v). New functionality often has large implications across the entire Payload repo, so it is best to discuss the architecture and approach before starting work on a pull request.
-
-### Code
-
-Most new functionality should keep testing in mind. With 1.0, testability of new features has been vastly improved. All top-level directories within the `test/` directory are for testing a specific category: `fields`, `collections`, etc.
-
-If it makes sense to add your feature to an existing test directory, please do so.
-
-A typical directory with `test/` will be structured like this:
-
-```text
-.
-├── config.ts
-├── int.spec.ts
-├── e2e.spec.ts
-└── payload-types.ts
-```
-
-- `config.ts` - This is the _granular_ Payload config for testing. It should be as lightweight as possible. Reference existing configs for an example
-- `int.spec.ts` - This is the test file run by jest. Any test file must have a `*int.spec.ts` suffix.
-- `e2e.spec.ts` - This is the end-to-end test file that will load up the admin UI using the above config and run Playwright tests. These tests are typically only needed if a large change is being made to the Admin UI.
-- `payload-types.ts` - Generated types from `config.ts`. Generate this file by running `yarn dev:generate-types my-test-dir`.
-
-The directory split up in this way specifically to reduce friction when creating tests and to add the ability to boot up Payload with that specific config.
-
-The following command will start Payload with your config: `yarn dev my-test-dir`. This command will start up Payload using your config and refresh a test database on every restart.
-
-When switching between test directories, you will want to remove your `node_modules/.cache ` manually or by running `yarn clean:cache`.
-
-NOTE: It is recommended to add the test credentials (located in `test/credentials.ts`) to your autofill for `localhost:3000/admin` as this will be required on every nodemon restart. The default credentials are `dev@payloadcms.com` as E-Mail and `test` as password.
-
-## Pull Requests
-
-For all Pull Requests, you should be extremely descriptive about both your problem and proposed solution. If there are any affected open or closed issues, please leave the issue number in your PR message.

docs/access-control/collections.mdx

@@ -10,27 +10,28 @@ You can define Collection-level Access Control within each Collection's `access`
 
 ## Available Controls
 
-| Function                 | Allows/Denies Access |
-| ------------------------ | -------------------- |
-| **[`create`](#create)**  | Used in the `create` operation |
-| **[`read`](#read)**      | Used in the `find` and `findByID` operations |
-| **[`update`](#update)**  | Used in the `update` operation |
-| **[`delete`](#delete)**  | Used in the `delete` operation |
+| Function                | Allows/Denies Access                         |
+| ----------------------- | -------------------------------------------- |
+| **[`create`](#create)** | Used in the `create` operation               |
+| **[`read`](#read)**     | Used in the `find` and `findByID` operations |
+| **[`update`](#update)** | Used in the `update` operation               |
+| **[`delete`](#delete)** | Used in the `delete` operation               |
 
 #### Auth-enabled Controls
 
 If a Collection supports [`Authentication`](/docs/authentication/overview), the following Access Controls become available:
 
-| Function                | Allows/Denies Access |
-| ----------------------- | -------------------- |
-| **[`admin`](#admin)**   | Used to restrict access to the Payload Admin panel |
+| Function                | Allows/Denies Access                                           |
+| ----------------------- | -------------------------------------------------------------- |
+| **[`admin`](#admin)**   | Used to restrict access to the Payload Admin panel             |
 | **[`unlock`](#unlock)** | Used to restrict which users can access the `unlock` operation |
 
 **Example Collection config:**
+
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Posts: CollectionConfig = {
+export const Posts: CollectionConfig = {
   slug: "posts",
   // highlight-start
   access: {
@@ -42,8 +43,6 @@ const Posts: CollectionConfig = {
   },
   // highlight-end
 };
-
-export default Categories;
 ```
 
 ### Create
@@ -52,10 +51,10 @@ Returns a boolean which allows/denies access to the `create` request.
 
 **Available argument properties:**
 
-| Option     | Description |
-| ---------- | ----------- |
+| Option     | Description                                                                |
+| ---------- | -------------------------------------------------------------------------- |
 | **`req`**  | The Express `request` object containing the currently authenticated `user` |
-| **`data`** | The data passed to create the document with. |
+| **`data`** | The data passed to create the document with.                               |
 
 **Example:**
 
@@ -79,20 +78,20 @@ Read access functions can return a boolean result or optionally return a [query
 
 **Available argument properties:**
 
-| Option    | Description |
-| --------- | ----------- |
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
 | **`req`** | The Express `request` object containing the currently authenticated `user` |
-| **`id`**  | `id` of document requested, if within `findByID` |
+| **`id`**  | `id` of document requested, if within `findByID`                           |
 
 **Example:**
 
 ```ts
-import { Access } from 'payload/config';
+import { Access } from 'payload/config'
 
 const canReadPage: Access = ({ req: { user } }) => {
   // allow authenticated users
   if (user) {
-    return true;
+    return true
   }
   // using a query constraint, guest users can access when a field named 'isPublic' is set to true
   return {
@@ -101,7 +100,7 @@ const canReadPage: Access = ({ req: { user } }) => {
       equals: true,
     },
   }
-};
+}
 ```
 
 ### Update
@@ -110,25 +109,25 @@ Update access functions can return a boolean result or optionally return a [quer
 
 **Available argument properties:**
 
-| Option     | Description |
-| ---------- | ----------- |
+| Option     | Description                                                                |
+| ---------- | -------------------------------------------------------------------------- |
 | **`req`**  | The Express `request` object containing the currently authenticated `user` |
-| **`id`**   | `id` of document requested to update |
-| **`data`** | The data passed to update the document with |
+| **`id`**   | `id` of document requested to update                                       |
+| **`data`** | The data passed to update the document with                                |
 
 **Example:**
 
 ```ts
-import { Access } from 'payload/config';
+import { Access } from 'payload/config'
 
 const canUpdateUser: Access = ({ req: { user }, id }) => {
   // allow users with a role of 'admin'
-  if (user.roles && user.roles.some(role => role === 'admin')) {
-    return true;
+  if (user.roles && user.roles.some((role) => role === 'admin')) {
+    return true
   }
   // allow any other users to update only oneself
-  return user.id === id;
-};
+  return user.id === id
+}
 ```
 
 ### Delete
@@ -137,10 +136,10 @@ Similarly to the Update function, returns a boolean or a [query constraint](/doc
 
 **Available argument properties:**
 
-| Option    | Description |
-| --------- | ----------- |
+| Option    | Description                                                                                         |
+| --------- | --------------------------------------------------------------------------------------------------- |
 | **`req`** | The Express `request` object with additional `user` property, which is the currently logged in user |
-| **`id`**  | `id` of document requested to delete |
+| **`id`**  | `id` of document requested to delete                                                                |
 
 **Example:**
 
@@ -150,7 +149,7 @@ import { Access } from 'payload/config'
 const canDeleteCustomer: Access = async ({ req, id }) => {
   if (!id) {
     // allow the admin UI to show controls to delete since it is indeterminate without the id
-    return true;
+    return true
   }
   // query another collection using the id
   const result = await req.payload.find({
@@ -160,10 +159,10 @@ const canDeleteCustomer: Access = async ({ req, id }) => {
     where: {
       customer: { equals: id },
     },
-  });
+  })
 
-  return result.totalDocs === 0;
-};
+  return result.totalDocs === 0
+}
 ```
 
 ### Admin
@@ -172,8 +171,8 @@ If the Collection is [used to access the Payload Admin panel](/docs/admin/overvi
 
 **Available argument properties:**
 
-| Option    | Description |
-| --------- | ----------- |
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
 | **`req`** | The Express `request` object containing the currently authenticated `user` |
 
 ### Unlock
@@ -182,6 +181,6 @@ Determines which users can [unlock](/docs/authentication/operations#unlock) othe
 
 **Available argument properties:**
 
-| Option    | Description |
-| --------- | ----------- |
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
 | **`req`** | The Express `request` object containing the currently authenticated `user` |

docs/access-control/fields.mdx

@@ -10,17 +10,18 @@ Field Access Control is specified with functions inside a field's config. All fi
 
 ## Available Controls
 
-| Function                 | Purpose |
-| ------------------------ | ------- |
-| **[`create`](#create)**  | Allows or denies the ability to set a field's value when creating a new document |
-| **[`read`](#read)**      | Allows or denies the ability to read a field's value |
-| **[`update`](#update)**  | Allows or denies the ability to update a field's value |
+| Function                | Purpose                                                                          |
+| ----------------------- | -------------------------------------------------------------------------------- |
+| **[`create`](#create)** | Allows or denies the ability to set a field's value when creating a new document |
+| **[`read`](#read)**     | Allows or denies the ability to read a field's value                             |
+| **[`update`](#update)** | Allows or denies the ability to update a field's value                           |
 
 **Example Collection config:**
+
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Posts: CollectionConfig = {
+export const Posts: CollectionConfig = {
   slug: 'posts',
   fields: [
     {
@@ -44,11 +45,11 @@ Returns a boolean which allows or denies the ability to set a field's value when
 
 **Available argument properties:**
 
-| Option            | Description |
-| ----------------- | ----------- |
+| Option            | Description                                                                |
+| ----------------- | -------------------------------------------------------------------------- |
 | **`req`**         | The Express `request` object containing the currently authenticated `user` |
-| **`data`**        | The full data passed to create the document. |
-| **`siblingData`** | Immediately adjacent field data passed to create the document. |
+| **`data`**        | The full data passed to create the document.                               |
+| **`siblingData`** | Immediately adjacent field data passed to create the document.             |
 
 ### Read
 
@@ -56,23 +57,25 @@ Returns a boolean which allows or denies the ability to read a field's value. If
 
 **Available argument properties:**
 
-| Option            | Description |
-| ----------------- | ----------- |
+| Option            | Description                                                                |
+| ----------------- | -------------------------------------------------------------------------- |
 | **`req`**         | The Express `request` object containing the currently authenticated `user` |
-| **`id`**          | `id` of the document being read |
-| **`doc`**         | The full document data. |
-| **`siblingData`** | Immediately adjacent field data of the document being read. |
+| **`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 |
-| ----------------- | ----------- |
+| Option            | Description                                                                |
+| ----------------- | -------------------------------------------------------------------------- |
 | **`req`**         | The Express `request` object containing the currently authenticated `user` |
-| **`id`**          | `id` of the document being updated |
-| **`data`**        | The full data passed to update the document. |
-| **`siblingData`** | Immediately adjacent field data passed to update the document with. |
-| **`doc`**         | The full document data, before the update is applied. |
+| **`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

@@ -8,30 +8,35 @@ keywords: globals, access control, permissions, documentation, Content Managemen
 
 You can define Global-level Access Control within each Global's `access` property. All Access Control functions accept one `args` argument.
 
-**Available argument properties:
+\*\*Available argument properties:
 
 ## Available Controls
 
-| Function                 | Allows/Denies Access |
-| ------------------------ | -------------------- |
-| **[`read`](#read)**      | Used in the `findOne` Global operation |
-| **[`update`](#update)**  | Used in the `update` Global operation |
+| Function                | Allows/Denies Access                   |
+| ----------------------- | -------------------------------------- |
+| **[`read`](#read)**     | Used in the `findOne` Global operation |
+| **[`update`](#update)** | Used in the `update` Global operation  |
 
 **Example Global config:**
+
 ```ts
-import { GlobalConfig } from 'payload/types';
+import { GlobalConfig } from 'payload/types'
 
 const Header: GlobalConfig = {
-  slug: "header",
+  slug: 'header',
   // highlight-start
   access: {
-    read: ({ req: { user } }) => { /* */ },
-    update: ({ req: { user } }) => { /* */ },
+    read: ({ req: { user } }) => {
+      /* */
+    },
+    update: ({ req: { user } }) => {
+      /* */
+    },
   },
   // highlight-end
-};
+}
 
-export default Header;
+export default Header
 ```
 
 ### Read
@@ -40,8 +45,8 @@ Returns a boolean result or optionally a [query constraint](/docs/queries/overvi
 
 **Available argument properties:**
 
-| Option    | Description |
-| --------- | ----------- |
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
 | **`req`** | The Express `request` object containing the currently authenticated `user` |
 
 ### Update
@@ -50,7 +55,7 @@ Returns a boolean result or optionally a [query constraint](/docs/queries/overvi
 
 **Available argument properties:**
 
-| Option     | Description |
-| ---------- | ----------- |
+| Option     | Description                                                                |
+| ---------- | -------------------------------------------------------------------------- |
 | **`req`**  | The Express `request` object containing the currently authenticated `user` |
-| **`data`** | The data passed to update the global with. |
+| **`data`** | The data passed to update the global with.                                 |

docs/access-control/overview.mdx

@@ -8,10 +8,7 @@ keywords: overview, access control, permissions, documentation, Content Manageme
 
 Access control within Payload is extremely powerful while remaining easy and intuitive to manage. Declaring who should have access to what documents is no more complex than writing a simple JavaScript function that either returns a `boolean` or a [`query`](/docs/queries/overview) constraint to restrict which documents users can interact with.
 
-<YouTube
-  id="DoPLyXG26Dg"
-  title="Overview of Payload Access Control"
-/>
+<YouTube id="DoPLyXG26Dg" title="Overview of Payload Access Control" />
 
 **Example use cases:**
 
@@ -32,13 +29,18 @@ Access control within Payload is extremely powerful while remaining easy and int
 const defaultPayloadAccess = ({ req: { user } }) => {
   // Return `true` if a user is found
   // and `false` if it is undefined or null
-  return Boolean(user);
+  return Boolean(user)
 }
 ```
 
 <Banner type="success">
-  <strong>Note:</strong><br/>
-  In the Local API, all Access Control functions are skipped by default, allowing your server to do whatever it needs. But, you can opt back in by setting the option <strong>overrideAccess</strong> to <strong>true</strong>.
+  <strong>Note:</strong>
+  <br />
+  In the Local API, all Access Control functions are skipped by default, allowing your server to do
+  whatever it needs. But, you can opt back in by setting the option <strong>
+    overrideAccess
+  </strong>{' '}
+  to <strong>false</strong>.
 </Banner>
 
 ### Access Control Types
@@ -49,12 +51,13 @@ You can manage access within Payload on three different levels:
 - [Fields](/docs/access-control/fields)
 - [Globals](/docs/access-control/globals)
 
-
 ### When Access Control is Executed
 
 <Banner type="success">
-  <strong>Note:</strong><br/>
-  Access control functions are utilized in two places. It's important to understand how and when your access control is executed.
+  <strong>Note:</strong>
+  <br />
+  Access control functions are utilized in two places. It's important to understand how and when
+  your access control is executed.
 </Banner>
 
 #### As you execute operations
@@ -70,8 +73,11 @@ To accomplish this, Payload ships with an `Access` operation, which is executed
 ### Argument Availability
 
 <Banner type="warning">
-  <strong>Important:</strong><br/>
-  When your access control functions are executed via the <strong>access</strong> operation, the <strong>id</strong> and <strong>data</strong> arguments will be <strong>undefined</strong>, because Payload is executing your functions without referencing a specific document.
+  <strong>Important:</strong>
+  <br />
+  When your access control functions are executed via the <strong>access</strong> operation, the{' '}
+  <strong>id</strong> and <strong>data</strong> arguments will be <strong>undefined</strong>,
+  because Payload is executing your functions without referencing a specific document.
 </Banner>
 
 If you use `id` or `data` within your access control functions, make sure to check that they are defined first. If they are not, then you can assume that your access control is being executed via the `access` operation, to determine solely what the user can do within the Admin UI.

docs/admin/bundlers.mdx

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

docs/admin/components.mdx

@@ -6,44 +6,43 @@ desc: Fully customize your Admin Panel by swapping in your own React components.
 keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-While designing the Payload Admin panel, we determined it should be as minimal and straightforward as possible to allow easy customization and control. There are many times where you may want to completely control how a whole view or a field works. You might even want to add in your own routes entirely. In order for Payload to support that level of customization without introducing versioning / future-proofing issues, Payload provides for a pattern to supply your own React components via your Payload config.
+While designing the Payload Admin panel, we determined it should be as minimal and straightforward as possible to allow easy customization and control. There are many times where you may want to completely control how a whole view or a field works. You might even want to add in new views entirely. In order for Payload to support this level of customization without introducing versioning / future-proofing issues, Payload provides for a pattern to supply your own React components via your Payload config.
 
 To swap in your own React component, first, consult the list of available component overrides below. Determine the scope that corresponds to what you are trying to accomplish, and then author your React component accordingly.
 
 <Banner type="success">
   <strong>Tip:</strong>
   <br />
-  Custom components will automatically be provided with all props that the
-  default component would accept.
+  Custom components will automatically be provided with all props that the default component normally
+  accepts.
 </Banner>
 
 ### Base Component Overrides
 
 You can override a set of admin panel-wide components by providing a component to your base Payload config's `admin.components` property. The following options are available:
 
-| Path                         | Description                                                                                                                                                                                                 |
-| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`Nav`**                    | Contains the sidebar and mobile Nav in its entirety.                                                                                                                                                        |
-| **`logout.Button`**          | A custom React component.
-| **`BeforeDashboard`**        | Array of components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                         |
-| **`AfterDashboard`**         | Array of components to inject into the built-in Dashboard, _after_ the default dashboard contents. [Demo](https://github.com/payloadcms/payload/tree/master/test/admin/components/AfterDashboard/index.tsx) |
-| **`BeforeLogin`**            | Array of components to inject into the built-in Login, _before_ the default login form.                                                                                                                     |
-| **`AfterLogin`**             | Array of components to inject into the built-in Login, _after_ the default login form.                                                                                                                      |
-| **`BeforeNavLinks`**         | Array of components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                         |
-| **`AfterNavLinks`**          | Array of components to inject into the built-in Nav, _after_ the links.                                                                                                                                     |
-| **`views.Account`**          | The Account view is used to show the currently logged in user's Account page.                                                                                                                               |
-| **`views.Dashboard`**        | The main landing page of the Admin panel.                                                                                                                                                                   |
-| **`graphics.Icon`**          | Used as a graphic within the `Nav` component. Often represents a condensed version of a full logo.                                                                                                          |
-| **`graphics.Logo`**          | The full logo to be used in contexts like the `Login` view.                                                                                                                                                 |
-| **`routes`**                 | Define your own routes to add to the Payload Admin UI. [More](#custom-routes)                                                                                                                               |
-| **`providers`**              | Define your own provider components that will wrap the Payload Admin UI. [More](#custom-providers)                                                                                                          |
+| Path                  | Description                                                                                                                                                                                                 |
+| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                         |
+| **`BeforeNavLinks`**  | Array of components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                         |
+| **`AfterNavLinks`**   | Array of components to inject into the built-in Nav, _after_ the links.                                                                                                                                     |
+| **`BeforeDashboard`** | Array of components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                         |
+| **`AfterDashboard`**  | Array of components to inject into the built-in Dashboard, _after_ the default dashboard contents. [Demo](https://github.com/payloadcms/payload/tree/main/test/admin/components/AfterDashboard/index.tsx) |
+| **`BeforeLogin`**     | Array of components to inject into the built-in Login, _before_ the default login form.                                                                                                                     |
+| **`AfterLogin`**      | Array of components to inject into the built-in Login, _after_ the default login form.                                                                                                                      |
+| **`logout.Button`**   | A custom React component.                                                                                                                                                                                   |
+| **`graphics.Icon`**   | Used as a graphic within the `Nav` component. Often represents a condensed version of a full logo.                                                                                                          |
+| **`graphics.Logo`**   | The full logo to be used in contexts like the `Login` view.                                                                                                                                                 |
+| **`providers`**       | Define your own provider components that will wrap the Payload Admin UI. [More](#custom-providers)                                                                                                          |
+| **`views`**           | Override or create new views within the Payload Admin UI. [More](#views)                                                                                                                             |
 
-#### Full example:
+Here is a full example showing how to swap some of these components for your own.
 
 `payload.config.js`
 
 ```ts
-import { buildConfig } from "payload/config";
+import { buildConfig } from 'payload/config'
+
 import {
   MyCustomNav,
   MyCustomLogo,
@@ -51,7 +50,7 @@ import {
   MyCustomAccount,
   MyCustomDashboard,
   MyProvider,
-} from "./customComponents";
+} from './customComponents'
 
 export default buildConfig({
   admin: {
@@ -68,27 +67,344 @@ export default buildConfig({
       providers: [MyProvider],
     },
   },
-});
+})
 ```
 
-_For more examples regarding how to customize components, look at the following [examples](https://github.com/payloadcms/payload/tree/master/test/admin/components)._
+#### Views
+
+You can easily swap entire views with your own by using the `admin.components.views` property. At the root level, Payload renders the following views dy default, all of which can be overridden:
+
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Account`**      | The Account view is used to show the currently logged in user's Account page.                                                |
+| **`Dashboard`**    | The main landing page of the Admin panel.                                                                                    |
+
+To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. For example:
+
+```ts
+// payload.config.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        Account: MyCustomAccountView,
+        Dashboard: MyCustomDashboardView,
+      },
+    },
+  },
+}
+```
+
+For more granular control, pass a configuration object instead. Payload exposes all of the properties of `<Route />` component in [React Router v5](https://v5.reactrouter.com):
+
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Component`** \* | Pass in the component that should be rendered when a user navigates to this route.                                           |
+| **`path`** \*      | React Router `path`. [See the React Router docs](https://v5.reactrouter.com/web/api/Route/path-string-string) for more info. |
+| **`exact`**        | React Router `exact` property. [More](https://v5.reactrouter.com/web/api/Route/exact-bool)                                   |
+| **`strict`**       | React Router `strict` property. [More](https://v5.reactrouter.com/web/api/Route/strict-bool)                                 |
+| **`sensitive`**    | React Router `sensitive` property. [More](https://v5.reactrouter.com/web/api/Route/sensitive-bool)                           |
+
+_\* An asterisk denotes that a property is required._
+
+#### Adding new views
+
+To add a _new_ view to the Admin Panel, simply add another key to the `views` object with at least a `path` and `Component` property. For example:
+
+```ts
+// payload.config.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        MyCustomView: {
+          Component: MyCustomView,
+          path: '/my-custom-view',
+        },
+      },
+    },
+  },
+}
+```
+
+_For more examples regarding how to customize components, look at the following [examples](https://github.com/payloadcms/payload/tree/main/test/admin/components)._
+
+For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component).
 
 ### Collections
 
-You can override components on a Collection-by-Collection basis via each Collection's `admin` property.
+You can override components on a collection-by-collection basis via their `admin` property.
 
-| Path             | Description                                                                                      |
-| ---------------- | ------------------------------------------------------------------------------------------------ |
-| **`views.Edit`** | Used while a document within this Collection is being edited.                                    |
-| **`views.List`** | The `List` view is used to render a paginated, filterable table of Documents in this Collection. |
+| Path                       | Description                                                                                                            |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| **`BeforeList`**           | Array of components to inject _before_ the built-in List view                                                          |
+| **`BeforeListTable`**      | Array of components to inject _before_ the built-in List view's table                                                  |
+| **`AfterList`**            | Array of components to inject _after_ the built-in List view                                                           |
+| **`AfterListTable`**       | Array of components to inject _after_ the built-in List view's table                                                   |
+| **`edit.SaveButton`**      | Replace the default `Save` button with a custom component. Drafts must be disabled                                     |
+| **`edit.SaveDraftButton`** | Replace the default `Save Draft` button with a custom component. Drafts must be enabled and autosave must be disabled. |
+| **`edit.PublishButton`**   | Replace the default `Publish` button with a custom component. Drafts must be enabled.                                  |
+| **`edit.PreviewButton`**   | Replace the default `Preview` button with a custom component.                                                          |
+| **`views`**                | Override or create new views within the Payload Admin UI. [More](#collection-views)                                    |
+
+Here is a full example showing how to swap some of these components for your own:
+
+`Collection.ts`
+
+```tsx
+import * as React from 'react'
+
+import {
+  CustomSaveButtonProps,
+  CustomSaveDraftButtonProps,
+  CustomPublishButtonProps,
+  CustomPreviewButtonProps,
+} from 'payload/types'
+
+export const CustomSaveButton: CustomSaveButtonProps = ({ DefaultButton, label }) => {
+  return <DefaultButton label={label} />
+}
+
+export const CustomSaveDraftButton: CustomSaveDraftButtonProps = ({
+  DefaultButton,
+  disabled,
+  label,
+  saveDraft,
+}) => {
+  return <DefaultButton label={label} disabled={disabled} saveDraft={saveDraft} />
+}
+
+export const CustomPublishButton: CustomPublishButtonProps = ({
+  DefaultButton,
+  disabled,
+  label,
+  publish,
+}) => {
+  return <DefaultButton label={label} disabled={disabled} publish={publish} />
+}
+
+export const CustomPreviewButton: CustomPreviewButtonProps = ({
+  DefaultButton,
+  disabled,
+  label,
+  preview,
+}) => {
+  return <DefaultButton label={label} disabled={disabled} preview={preview} />
+}
+
+export const MyCollection: SanitizedCollectionConfig = {
+  slug: 'my-collection',
+  admin: {
+    components: {
+      edit: {
+        SaveButton: CustomSaveButton,
+        SaveDraftButton: CustomSaveDraftButton,
+        PublishButton: CustomPublishButton,
+        PreviewButton: CustomPreviewButton,
+      },
+    },
+  }
+}
+```
+
+#### Collection views
+
+To swap out entire views on collections, you can use the `admin.components.views` property on the collection's config. Payload renders the following views dy default, all of which can be overridden:
+
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Edit`**         | The Edit view is used to edit a single document for a given collection.                                                      |
+| **`List`**         | The List view is used to show a list of documents for a given collection.                                                    |
+
+To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, tabs, etc, _as well as all nested routes_.
+
+```ts
+// Collection.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        Edit: MyCustomEditView,
+        List: MyCustomListView,
+      },
+    },
+  },
+}
+```
+
+_For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component)._
+
+To swap specific _nested_ views within the parent `Edit` view, you can use the `admin.components.views.Edit` property on the globals's config. This will only replace the nested view, leaving the page breadcrumbs, title, tabs, etc intact.
+
+```ts
+// Collection.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        Edit: {
+          Default: MyCustomDefaultTab,
+        },
+      },
+    },
+  },
+}
+```
+
+You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
 
 ### Globals
 
-As with Collections, You can override components on a global-by-global basis via their `admin` property.
+As with Collections, you can override components on a global-by-global basis via their `admin` property.
 
-| Path             | Description                             |
-| ---------------- | --------------------------------------- |
-| **`views.Edit`** | Used while this Global is being edited. |
+| Path                       | Description                                                                                                            |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| **`edit.SaveButton`**      | Replace the default `Save` button with a custom component. Drafts must be disabled                                     |
+| **`edit.SaveDraftButton`** | Replace the default `Save Draft` button with a custom component. Drafts must be enabled and autosave must be disabled. |
+| **`edit.PublishButton`**   | Replace the default `Publish` button with a custom component. Drafts must be enabled.                                  |
+| **`edit.PreviewButton`**   | Replace the default `Preview` button with a custom component.                                                          |
+| **`views`**                | Override or create new views within the Payload Admin UI. [More](#global-views)                                        |
+
+#### Global views
+
+To swap out views for globals, you can use the `admin.components.views` property on the global's config. Payload renders the following views dy default, all of which can be overridden:
+
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Edit`**         | The Edit view is used to edit a single document for a given Global.                                                          |
+
+To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, and tabs, _as well as all nested views_.
+
+```ts
+// Global.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        Edit: MyCustomEditView,
+      },
+    },
+  },
+}
+```
+
+_For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component)._
+
+To swap specific _nested_ views within the parent `Edit` view, you can use the `admin.components.views.Edit` property on the globals's config. This will only replace the nested view, leaving the page breadcrumbs, title, and tabs intact.
+
+```ts
+// Global.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        Edit: {
+          Default: MyCustomDefaultTab,
+        },
+      },
+    },
+  },
+}
+```
+
+You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
+
+### Custom Tabs
+
+You can easily swap individual collection or global edit views. To do this, pass an _object_ to the `admin.components.views.Edit` property of the config. Payload renders the following views dy default, all of which can be overridden:
+
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Default`**      | The Default view is the primary view in which your document is edited.                                                       |
+| **`Versions`**     | The Versions view is used to view the version history of a single document. [More details](../versions)                      |
+| **`Version`**      | The Version view is used to view a single version of a single document for a given collection. [More details](../versions).  |
+| **`API`**          | The API view is used to display the REST API JSON response for a given document.                                             |
+| **`LivePreview`**  | The LivePreview view is used to display the Live Preview interface. [More details](../live-preview)                          |
+
+Here is an example:
+
+```ts
+// Collection.ts or Global.ts
+export const MyCollection: SanitizedCollectionConfig = {
+  slug: 'my-collection',
+  admin: {
+    components: {
+      views: {
+        Edit: { // You can also define `components.views.Edit` as a component, this will override _all_ nested views
+          Default: MyCustomDefaultTab,
+          Versions: MyCustomVersionsTab,
+          Version: MyCustomVersionTab,
+          API: MyCustomAPITab,
+          LivePreview: MyCustomLivePreviewTab,
+        },
+      },
+    },
+  },
+}
+```
+
+To add a _new_ tab to the `Edit` view, simply add another key to `components.views.Edit[key]` with at least a `path` and `Component` property. For example:
+
+```ts
+// `Collection.ts` or `Global.ts`
+export const MyCollection: SanitizedCollectionConfig = {
+  slug: 'my-collection',
+  admin: {
+    components: {
+      views: {
+        Edit: {
+          MyCustomTab: {
+            Component: MyCustomTab,
+            path: '/my-custom-tab',
+            // You an swap the entire tab component out for your own
+            Tab: MyCustomTab
+          },
+          AnotherCustomView: {
+            Component: AnotherCustomView,
+            path: '/another-custom-view',
+            // Or you can use the default tab component and just pass in your own label and href
+            Tab: {
+              label: 'Another Custom View',
+              href: '/another-custom-view',
+            }
+          },
+        },
+      },
+    },
+  },
+}
+```
+
+### Building a custom view component
+
+Your custom view components will be given all the props that a React Router `<Route />` typically would receive, as well as two props from Payload:
+
+| Prop                    | Description                                                                  |
+| ----------------------- | ---------------------------------------------------------------------------- |
+| **`user`**              | The currently logged in user. Will be `null` if no user is logged in.        |
+| **`canAccessAdmin`** \* | If the currently logged in user is allowed to access the admin panel or not. |
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  <br />
+  It's up to you to secure your custom views. If your view requires a user to be logged in or to
+  have certain access rights, you should handle that within your view component yourself.
+</Banner>
+
+#### Example
+
+You can find examples of custom views in the [Payload source code `/test/admin/components/views` folder](https://github.com/payloadcms/payload/tree/main/test/admin/components/views). There, you'll find two custom views:
+
+1. A custom view that uses the `DefaultTemplate`, which is the built-in Payload template that displays the sidebar and "eyebrow nav"
+1. A custom view that uses the `MinimalTemplate` - which is just a centered template used for things like logging in or out
+
+To see how to pass in your custom views to create custom views of your own, take a look at the `admin.components.views` property of the [Payload test admin config](https://github.com/payloadcms/payload/blob/main/test/admin/config.ts).
 
 ### Fields
 
@@ -97,10 +413,9 @@ All Payload fields support the ability to swap in your own React components. So,
 <Banner type="success">
   <strong>Tip:</strong>
   <br />
-  Don't see a built-in field type that you need? Build it! Using a combination
-  of custom validation and custom components, you can override the entirety of
-  how a component functions within the admin panel and effectively create your
-  own field type.
+  Don't see a built-in field type that you need? Build it! Using a combination of custom validation
+  and custom components, you can override the entirety of how a component functions within the admin
+  panel and effectively create your own field type.
 </Banner>
 
 **Fields support the following custom components:**
@@ -126,15 +441,15 @@ These are the props that will be passed to your custom Cell to use in your own c
 #### Example
 
 ```tsx
-import React from "react";
-import "./index.scss";
-const baseClass = "custom-cell";
+import React from 'react'
+import './index.scss'
+const baseClass = 'custom-cell'
 
 const CustomCell: React.FC<Props> = (props) => {
-  const { field, colIndex, collection, cellData, rowData } = props;
+  const { field, colIndex, collection, cellData, rowData } = props
 
-  return <span className={baseClass}>{cellData}</span>;
-};
+  return <span className={baseClass}>{cellData}</span>
+}
 ```
 
 ## Field Component
@@ -146,75 +461,31 @@ When writing your own custom components you can make use of a number of hooks to
 When swapping out the `Field` component, you'll be responsible for sending and receiving the field's `value` from the form itself. To do so, import the `useField` hook as follows:
 
 ```tsx
-import { useField } from "payload/components/forms";
+import { useField } from 'payload/components/forms'
 
-type Props = { path: string };
+type Props = { path: string }
 
 const CustomTextField: React.FC<Props> = ({ path }) => {
   // highlight-start
-  const { value, setValue } = useField<Props>({ path });
+  const { value, setValue } = useField<Props>({ path })
   // highlight-end
 
-  return (
-    <input onChange={(e) => setValue(e.target.value)} value={value.path} />
-  );
-};
+  return <input onChange={(e) => setValue(e.target.value)} value={value.path} />
+}
 ```
 
 <Banner type="success">
-  For more information regarding the hooks that are available to you while you
-  build custom components, including the <strong>useField</strong> hook, <a href="/docs/admin/hooks" style={{ color: "black" }}>click here</a>.
+  For more information regarding the hooks that are available to you while you build custom
+  components, including the <strong>useField</strong> hook, [click here](/docs/admin/hooks).
 </Banner>
 
-## Custom routes
-
-You can easily add your own custom routes to the Payload Admin panel using the `admin.components.routes` property. Payload currently uses the extremely powerful React Router v5.x and custom routes support all the properties of the React Router `<Route />` component.
-
-**Custom routes support the following properties:**
-
-| Property           | Description                                                                                                                  |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`Component`** \* | Pass in the component that should be rendered when a user navigates to this route.                                           |
-| **`path`** \*      | React Router `path`. [See the React Router docs](https://v5.reactrouter.com/web/api/Route/path-string-string) for more info. |
-| **`exact`**        | React Router `exact` property. [More](https://v5.reactrouter.com/web/api/Route/exact-bool)                                   |
-| **`strict`**       | React Router `strict` property. [More](https://v5.reactrouter.com/web/api/Route/strict-bool)                                 |
-| **`sensitive`**    | React Router `sensitive` property. [More](https://v5.reactrouter.com/web/api/Route/sensitive-bool)                           |
-
-_\* An asterisk denotes that a property is required._
-
-#### Custom route components
-
-Your custom route components will be given all the props that a React Router `<Route />` typically would receive, as well as two props from Payload:
-
-| Prop                    | Description                                                                  |
-| ----------------------- | ---------------------------------------------------------------------------- |
-| **`user`**              | The currently logged in user. Will be `null` if no user is logged in.        |
-| **`canAccessAdmin`** \* | If the currently logged in user is allowed to access the admin panel or not. |
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  <br />
-  It's up to you to secure your custom routes. If your route requires a user to
-  be logged in or to have certain access rights, you should handle that within
-  your route component yourself.
-</Banner>
-
-#### Example
-
-You can find examples of custom route views in the [Payload source code `/test/admin/components/views` folder](https://github.com/payloadcms/payload/tree/master/test/admin/components/views). There, you'll find two custom routes:
-
-1. A custom view that uses the `DefaultTemplate`, which is the built-in Payload template that displays the sidebar and "eyebrow nav"
-1. A custom view that uses the `MinimalTemplate` - which is just a centered template used for things like logging in or out
-
-To see how to pass in your custom views to create custom routes of your own, take a look at the `admin.components.routes` property of the [Payload test admin config](https://github.com/payloadcms/payload/blob/master/test/admin/config.ts).
-
 ## Custom providers
 
 As your admin customizations gets more complex you may want to share state between fields or other components. You can add custom providers to do add your own context to any Payload app for use in other custom components within the admin panel. Within your config add `admin.components.providers`, these can be used to share context or provide other custom functionality. Read the [React context](https://reactjs.org/docs/context.html) docs to learn more.
 
 <Banner type="warning">
-  <strong>Reminder:</strong> Don't forget to pass the **children** prop through
-  the provider component for the admin UI to show
+  <strong>Reminder:</strong> Don't forget to pass the **children** prop through the provider
+  component for the admin UI to show
 </Banner>
 
 ### Styling Custom Components
@@ -232,41 +503,42 @@ To make use of Payload SCSS variables / mixins to use directly in your own compo
 When developing custom components you can support multiple languages to be consistent with Payload's i18n support. The best way to do this is to add your translation resources to the [i18n configuration](https://payloadcms.com/docs/configuration/i18n) and import `useTranslation` from `react-i18next` in your components.
 
 For example:
+
 ```tsx
-import { useTranslation } from 'react-i18next';
+import { useTranslation } from 'react-i18next'
 
 const CustomComponent: React.FC = () => {
   // highlight-start
-  const { t, i18n } = useTranslation('namespace1');
+  const { t, i18n } = useTranslation('namespace1')
   // highlight-end
 
   return (
     <ul>
-      <li>{ t('key', { variable: 'value' }) }</li>
-      <li>{ t('namespace2:key', { variable: 'value' }) }</li>
-      <li>{ i18n.language }</li>
+      <li>{t('key', { variable: 'value' })}</li>
+      <li>{t('namespace2:key', { variable: 'value' })}</li>
+      <li>{i18n.language}</li>
     </ul>
-  );
-};
+  )
+}
 ```
 
 ### Getting the current locale
 
-In any custom component you can get the selected locale with the `useLocale` hook. Here is a simple example:
+In any custom component you can get the selected locale with `useLocale` hook. `useLocale` returns the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
 
 ```tsx
-import { useLocale } from "payload/components/utilities";
+import { useLocale } from 'payload/components/utilities'
 
 const Greeting: React.FC = () => {
   // highlight-start
-  const locale = useLocale();
+  const locale = useLocale()
   // highlight-end
 
   const trans = {
-    en: "Hello",
-    es: "Hola",
-  };
+    en: 'Hello',
+    es: 'Hola',
+  }
 
-  return <span> {trans[locale]} </span>;
-};
+  return <span> {trans[locale.code]} </span>
+}
 ```

docs/admin/customizing-css.mdx

@@ -13,15 +13,16 @@ You can add your own CSS by providing your base Payload config with a path to yo
 To do so, provide your base Payload config with a path to your own stylesheet. It can be either a CSS or SCSS file.
 
 **Example in payload.config.js:**
+
 ```ts
-import { buildConfig } from 'payload/config';
-import path from 'path';
+import { buildConfig } from 'payload/config'
+import path from 'path'
 
 const config = buildConfig({
-	admin: {
-		css: path.resolve(__dirname, 'relative/path/to/stylesheet.scss'),
-	},
-});
+  admin: {
+    css: path.resolve(__dirname, 'relative/path/to/stylesheet.scss'),
+  },
+})
 ```
 
 ### Overriding built-in styles
@@ -30,7 +31,7 @@ To make it as easy as possible for you to override our styles, Payload uses [BEM
 
 In addition to adding your own style definitions, you can also override Payload's built-in CSS variables. We use as much as possible behind the scenes, and you can override any of them that you'd like to.
 
-You can find the built-in Payload CSS variables within [`./src/admin/scss/app.scss`](https://github.com/payloadcms/payload/blob/master/src/admin/scss/app.scss) and [`./src/admin/scss/colors.scss`](https://github.com/payloadcms/payload/blob/master/src/admin/scss/colors.scss). The following variables are defined and can be overridden:
+You can find the built-in Payload CSS variables within [`./src/admin/scss/app.scss`](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/scss/app.scss) and [`./src/admin/scss/colors.scss`](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/scss/colors.scss). The following variables are defined and can be overridden:
 
 - Breakpoints
 - Base color shades (white to black by default)
@@ -43,7 +44,8 @@ You can find the built-in Payload CSS variables within [`./src/admin/scss/app.sc
 #### Dark mode
 
 <Banner type="warning">
-  If you're overriding colors or theme elevations, make sure to consider how your changes will affect dark mode.
+  If you're overriding colors or theme elevations, make sure to consider how your changes will
+  affect dark mode.
 </Banner>
 
 By default, Payload automatically overrides all `--theme-elevation`s and inverts all success / warning / error shades to suit dark mode. We also update some base theme variables like `--theme-bg`, `--theme-text`, etc.

docs/admin/environment-vars.mdx

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

docs/admin/excluding-server-code.mdx

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

docs/admin/hooks.mdx

@@ -24,7 +24,7 @@ const CustomTextField: React.FC<Props> = ({ path }) => {
   const { value, setValue } = useField<string>({ path })
   // highlight-end
 
-  return <input onChange={e => setValue(e.target.value)} value={value.path} />
+  return <input onChange={(e) => setValue(e.target.value)} value={value.path} />
 }
 ```
 
@@ -57,7 +57,8 @@ const {
 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.
+  <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.
@@ -65,21 +66,19 @@ Thanks to the awesome package [`use-context-selector`](https://github.com/dai-sh
 You can pass a Redux-like selector into the hook, which will ensure that you retrieve only the field that you want. The selector takes an argument with type of `[fields: Fields, dispatch: React.Dispatch<Action>]]`.
 
 ```tsx
-import { useFormFields } from 'payload/components/forms';
+import { useFormFields } from 'payload/components/forms'
 
 const MyComponent: React.FC = () => {
   // Get only the `amount` field state, and only cause a rerender when that field changes
-  const amount = useFormFields(([fields, dispatch]) => fields.amount);
+  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);
+  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>
-    );
+    return <span>The fee is ${(amount.value * feePercentage.value) / 100}</span>
   }
-};
+}
 ```
 
 ### useAllFormFields
@@ -117,7 +116,7 @@ If you are building a custom component, then you should use `setValue` which is
 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)                  |
@@ -127,46 +126,523 @@ You can send the following actions to the `dispatchFields` function.
 | **`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/master/src/admin/components/forms/Form/types.ts).
+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.
+  <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:
+The `useForm` hook returns an object with the following properties: |
 
-| Action               | Description                                                         |
-|----------------------|---------------------------------------------------------------------|
-| **`fields`**         | Deprecated. This property cannot be relied on as up-to-date.        |
-| **`submit`**         | Method to trigger the form to submit                                |
-| **`dispatchFields`** | Dispatch actions to the form field state                            |
-| **`validateForm`**   | Trigger a validation of the form state                              |
-| **`createFormData`** | Create a `multipart/form-data` object from the current form's state |
-| **`disabled`**       | Boolean denoting whether or not the form is disabled                |
-| **`getFields`**      | Gets all fields from state                                          |
-| **`getField`**       | Gets a single field from state by path                              |
-| **`getData`**        | Returns the data stored in the form                                 |
-| **`getSiblingData`** | Returns form sibling data for the given field path                  |
-| **`setModified`**    | Set the form's `modified` state                                     |
-| **`setProcessing`**  | Set the form's `processing` state                                   |
-| **`setSubmitted`**   | Set the form's `submitted` state                                    |
-| **`formRef`**        | The ref from the form HTML element                                  |
-| **`reset`**          | Method to reset the form to its initial state                       |
+<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 programtically add a row to an array or block field.',
+        drawerSlug: 'addFieldRow',
+        drawerContent: (
+<>
+  <TableWithDrawers
+    columns={[
+      'Prop',
+      'Description',
+    ]}
+    rows={[
+      [
+        {
+          value: <strong><code>path</code></strong>,
+        },
+        {
+          value: "The path to the array or block field",
+        },
+      ],
+      [
+        {
+          value: <strong><code>rowIndex</code></strong>,
+        },
+        {
+          value: "The index of the row to add. If omitted, the row will be added to the end of the array.",
+        },
+      ],
+      [
+        {
+          value: <strong><code>data</code></strong>,
+        },
+        {
+          value: "The data to add to the row",
+        },
+      ],
+    ]}
+  />
+
+{' '}
+
+<br />
+
+{' '}
+
+<pre>
+  {`import { useForm } from "payload/components/forms";
+
+export const CustomArrayManager = () => {
+  const { addFieldRow } = useForm()
+
+  return (
+    <button
+      type="button"
+      onClick={() => {
+        addFieldRow({
+          path: "arrayField",
+          rowIndex: 0,
+          data: {
+            textField: "text",
+            // blockType: "yourBlockSlug",
+            // ^ if managing a block array, you need to specify the block type
+          },
+        })
+      }}
+    >
+      Add Row
+    </button>
+  )
+}`}
+</pre>
+
+  <p>An example config to go along with the custom component</p>
+  <pre>
+{`const ExampleCollection = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "arrayField",
+      type: "array",
+      fields: [
+        {
+          name: "textField",
+          type: "text",
+        },
+      ],
+    },
+    {
+      type: "ui",
+      name: "customArrayManager",
+      admin: {
+        components: {
+          Field: CustomArrayManager,
+        },
+      },
+    },
+  ],
+}`}
+  </pre>
+</>
+        )
+      }
+    ],
+    [
+      {
+        value: <strong><code>removeFieldRow</code></strong>,
+      },
+      {
+        value: "Method to remove a row from an array or block field",
+      },
+      {
+        drawerTitle: 'removeFieldRow',
+        drawerDescription: 'A useful method to programtically remove a row from an array or block field.',
+        drawerSlug: 'removeFieldRow',
+        drawerContent: (
+<>
+  <TableWithDrawers
+    columns={[
+      'Prop',
+      'Description',
+    ]}
+    rows={[
+      [
+        {
+          value: <strong><code>path</code></strong>,
+        },
+        {
+          value: "The path to the array or block field",
+        },
+      ],
+      [
+        {
+          value: <strong><code>rowIndex</code></strong>,
+        },
+        {
+          value: "The index of the row to remove",
+        },
+      ],
+    ]}
+  />
+
+{' '}
+
+<br />
+
+{' '}
+
+<pre>
+  {`import { useForm } from "payload/components/forms";
+
+export const CustomArrayManager = () => {
+  const { removeFieldRow } = useForm()
+
+  return (
+    <button
+      type="button"
+      onClick={() => {
+        removeFieldRow({
+          path: "arrayField",
+          rowIndex: 0,
+        })
+      }}
+    >
+      Remove Row
+    </button>
+  )
+}`}
+</pre>
+
+  <p>An example config to go along with the custom component</p>
+  <pre>
+{`const ExampleCollection = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "arrayField",
+      type: "array",
+      fields: [
+        {
+          name: "textField",
+          type: "text",
+        },
+      ],
+    },
+    {
+      type: "ui",
+      name: "customArrayManager",
+      admin: {
+        components: {
+          Field: CustomArrayManager,
+        },
+      },
+    },
+  ],
+}`}
+  </pre>
+</>
+        )
+      }
+    ],
+    [
+      {
+        value: <strong><code>replaceFieldRow</code></strong>,
+      },
+      {
+        value: "Method to replace a row from an array or block field",
+      },
+      {
+        drawerTitle: 'replaceFieldRow',
+        drawerDescription: 'A useful method to programtically replace a row from an array or block field.',
+        drawerSlug: 'replaceFieldRow',
+        drawerContent: (
+<>
+  <TableWithDrawers
+    columns={[
+      'Prop',
+      'Description',
+    ]}
+    rows={[
+      [
+        {
+          value: <strong><code>path</code></strong>,
+        },
+        {
+          value: "The path to the array or block field",
+        },
+      ],
+      [
+        {
+          value: <strong><code>rowIndex</code></strong>,
+        },
+        {
+          value: "The index of the row to replace",
+        },
+      ],
+      [
+        {
+          value: <strong><code>data</code></strong>,
+        },
+        {
+          value: "The data to replace within the row",
+        },
+      ],
+    ]}
+  />
+
+{' '}
+
+<br />
+
+{' '}
+
+<pre>
+  {`import { useForm } from "payload/components/forms";
+
+export const CustomArrayManager = () => {
+  const { replaceFieldRow } = useForm()
+
+  return (
+    <button
+      type="button"
+      onClick={() => {
+        replaceFieldRow({
+          path: "arrayField",
+          rowIndex: 0,
+          data: {
+            textField: "updated text",
+            // blockType: "yourBlockSlug",
+            // ^ if managing a block array, you need to specify the block type
+          },
+        })
+      }}
+    >
+      Replace Row
+    </button>
+  )
+}`}
+</pre>
+
+  <p>An example config to go along with the custom component</p>
+  <pre>
+{`const ExampleCollection = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "arrayField",
+      type: "array",
+      fields: [
+        {
+          name: "textField",
+          type: "text",
+        },
+      ],
+    },
+    {
+      type: "ui",
+      name: "customArrayManager",
+      admin: {
+        components: {
+          Field: CustomArrayManager,
+        },
+      },
+    },
+  ],
+}`}
+  </pre>
+</>
+        )
+      }
+    ],
+  ]}
+/>
 
 ### 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                                                         |
-| **`type`**                | The type of document being edited (collection or global)                                                           |
 | **`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                                                                                        |
@@ -179,75 +655,72 @@ The `useDocumentInfo` hook provides lots of information about the document curre
 **Example:**
 
 ```tsx
-import { useDocumentInfo } from 'payload/components/utilities';
+import { useDocumentInfo } from 'payload/components/utilities'
 
 const LinkFromCategoryToPosts: React.FC = () => {
   // highlight-start
-  const { id } = useDocumentInfo();
+  const { id } = useDocumentInfo()
   // highlight-end
 
   // id will be undefined on the create form
   if (!id) {
-    return null;
+    return null
   }
 
   return (
-    <a href={`/admin/collections/posts?where[or][0][and][0][category][in][0]=[${id}]`} >
+    <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 with the `useLocale` hook. Here is a simple example:
+In any custom component you can get the selected locale object with the `useLocale` hook. `useLocale`gives you the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
 
 ```tsx
-import { useLocale } from 'payload/components/utilities';
+import { useLocale } from 'payload/components/utilities'
 
 const Greeting: React.FC = () => {
   // highlight-start
-  const locale = useLocale();
+  const locale = useLocale()
   // highlight-end
 
   const trans = {
     en: 'Hello',
     es: 'Hola',
-  };
+  }
 
-  return (
-    <span> { trans[locale] } </span>
-  );
-};
+  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.)                    |
-| **`permissions`**   | The permissions of the current user                                                     |
+| Property                 | Description                                                                             |
+| ------------------------ | --------------------------------------------------------------------------------------- |
+| **`user`**               | The currently logged in user                                                            |
+| **`logOut`**             | A method to log out the currently logged in user                                        |
+| **`refreshCookie`**      | A method to trigger the silent refreshing of a user's auth token                        |
+| **`setToken`**           | Set the token of the user, to be decoded and used to reset the user and token in memory |
+| **`token`**              | The logged in user's token (useful for creating preview links, etc.)                    |
+| **`refreshPermissions`** | Load new permissions (useful when content that effects permissions has been changed)    |
+| **`permissions`**        | The permissions of the current user                                                     |
 
 ```tsx
-import { useAuth } from 'payload/components/utilities';
-import { User } from '../payload-types.ts';
+import { useAuth } from 'payload/components/utilities'
+import { User } from '../payload-types.ts'
 
 const Greeting: React.FC = () => {
   // highlight-start
-  const { user } = useConfig<User>();
+  const { user } = useAuth<User>()
   // highlight-end
 
-  return (
-    <span>Hi, {user.email}!</span>
-  );
-};
+  return <span>Hi, {user.email}!</span>
+}
 ```
 
 ### useConfig
@@ -255,17 +728,15 @@ const Greeting: React.FC = () => {
 Used to easily fetch the full Payload config.
 
 ```tsx
-import { useConfig } from 'payload/components/utilities';
+import { useConfig } from 'payload/components/utilities'
 
 const MyComponent: React.FC = () => {
   // highlight-start
-  const config = useConfig();
+  const config = useConfig()
   // highlight-end
 
-  return (
-    <span>{config.serverURL}</span>
-  );
-};
+  return <span>{config.serverURL}</span>
+}
 ```
 
 ### useEditDepth
@@ -273,16 +744,14 @@ const MyComponent: React.FC = () => {
 Sends back how many editing levels "deep" the current component is. Edit depth is relevant while adding new documents / editing documents in modal windows and other cases.
 
 ```tsx
-import { useEditDepth } from 'payload/components/utilities';
+import { useEditDepth } from 'payload/components/utilities'
 
 const MyComponent: React.FC = () => {
   // highlight-start
-  const editDepth = useEditDepth();
+  const editDepth = useEditDepth()
   // highlight-end
 
-  return (
-    <span>My component is {editDepth} levels deep</span>
-  )
+  return <span>My component is {editDepth} levels deep</span>
 }
 ```
 

docs/admin/overview.mdx

@@ -8,45 +8,53 @@ keywords: admin, components, custom, customize, documentation, Content Managemen
 
 Payload dynamically generates a beautiful, fully functional React admin panel to manage your data. It's extremely powerful and can be customized / extended upon easily by swapping in your own React components. You can add additional views, modify how built-in views look / work, swap out Payload branding for your client's, build your own field types and much more.
 
-The Payload Admin panel is built with Webpack, code-split, highly performant (even with 100+ fields), and written fully in TypeScript.
+The Payload Admin panel can be bundled with our officially supported [Vite](/docs/admin/vite) and [webpack](/docs/admin/webpack) bundlers or you can integrate another bundler following our adapter pattern approach.
+When bundled, it is code-split, highly performant (even with 100+ fields), and written fully in TypeScript.
 
 <Banner type="success">
-  The Admin panel is meant to be simple enough to give you a starting point but
-  not bring too much complexity, so that you can easily customize it to suit the
-  needs of your application and your editors.
+  The Admin panel is meant to be simple enough to give you a starting point but not bring too much
+  complexity, so that you can easily customize it to suit the needs of your application and your
+  editors.
 </Banner>
 
-![Payload's Admin panel built in React](https://payloadcms.com/images/docs/admin.jpg)
-
-_Screenshot of the Admin panel while editing a document from an example `AllFields` collection_
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/admin.jpg"
+  srcDark="https://payloadcms.com/images/docs/admin-dark.jpg"
+  alt="Admin panel with collapsible sidebar"
+  caption="Redesigned admin panel with a collapsible sidebar that's open by default, providing greater extensibility and enhanced horizontal real estate."
+/>
 
 ## Admin Options
 
 All options for the Admin panel are defined in your base Payload config file.
 
-| Option                | Description                                                                                                                                                                                                                                                  |
-| --------------------- | -------------------------------------------------------------------------------------------------- |
-| `user`                | The `slug` of a Collection that you want be used to log in to the Admin dashboard. [More](/docs/admin/overview#the-admin-user-collection)                                                                                                                    |
-| `buildPath`           | Specify an absolute path for where to store the built Admin panel bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                                                                                                             |
-| `meta`                | Base meta data to use for the Admin panel. Included properties are `titleSuffix`, `ogImage`, and `favicon`.                                                                                                                                                  |
-| `disable`             | If set to `true`, the entire Admin panel will be disabled.                                                                                                                                                                                                   |
-| `indexHTML`           | Optionally replace the entirety of the `index.html` file used by the Admin panel. Reference the [base index.html file](https://github.com/payloadcms/payload/blob/master/src/admin/index.html) to ensure your replacement has the appropriate HTML elements. |
-| `css`                 | Absolute path to a stylesheet that you can use to override / customize the Admin panel styling. [More](/docs/admin/customizing-css).                                                                                                                         |
-| `scss`                | Absolute path to a Sass variables / mixins stylesheet meant to override Payload styles to make for an easy re-skinning of the Admin panel. [More](/docs/admin/customizing-css#overriding-scss-variables).                                                    |
-| `dateFormat`          | Global date format that will be used for all dates in the Admin panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                                                                                                               |
-| `avatar`              | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                                                                                                                     |
-| `components`          | Component overrides that affect the entirety of the Admin panel. [More](/docs/admin/components)                                                                                                                                                              |
-| `webpack`             | Customize the Webpack config that's used to generate the Admin panel. [More](/docs/admin/webpack)                                                                                                                                                            |     |
-| **`logoutRoute`**     | The route for the `logout` page.                                                                                                                                                                                                                             |
-| **`inactivityRoute`** | The route for the `logout` inactivity page.                                                                                                                                                                                                                  |
+| Option            | Description                                                                                                                                                                                                                                                                 |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bundler`         | The bundler that you would like to use to bundle the admin panel. Officially supported bundlers: [Webpack](/docs/admin/webpack) and [Vite](/docs/admin/vite).                                                                                                               |
+| `user`            | The `slug` of a Collection that you want be used to log in to the Admin dashboard. [More](/docs/admin/overview#the-admin-user-collection)                                                                                                                                   |
+| `buildPath`       | Specify an absolute path for where to store the built Admin panel bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                                                                                                                            |
+| `meta`            | Base meta data to use for the Admin panel. Included properties are `titleSuffix`, `ogImage`, and `favicon`.                                                                                                                                                                 |
+| `disable`         | If set to `true`, the entire Admin panel will be disabled.                                                                                                                                                                                                                  |
+| `indexHTML`       | Optionally replace the entirety of the `index.html` file used by the Admin panel. Reference the [base index.html file](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/index.html) to ensure your replacement has the appropriate HTML elements. |
+| `css`             | Absolute path to a stylesheet that you can use to override / customize the Admin panel styling. [More](/docs/admin/customizing-css).                                                                                                                                        |
+| `scss`            | Absolute path to a Sass variables / mixins stylesheet meant to override Payload styles to make for an easy re-skinning of the Admin panel. [More](/docs/admin/customizing-css#overriding-scss-variables).                                                                   |
+| `dateFormat`      | Global date format that will be used for all dates in the Admin panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                                                                                                                              |
+| `avatar`          | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                                                                                                                                    |
+| `autoLogin`       | Used to automate admin log-in for dev and demonstration convenience. [More](/docs/authentication/config).                                                                                                                                                                   |
+| `livePreview`     | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).                                                                                                                                                    |
+| `components`      | Component overrides that affect the entirety of the Admin panel. [More](/docs/admin/components)                                                                                                                                                                             |
+| `webpack`         | Customize the Webpack config that's used to generate the Admin panel. [More](/docs/admin/webpack)                                                                                                                                                                           |
+| `vite`            | Customize the Vite config that's used to generate the Admin panel. [More](/docs/admin/vite)                                                                                                                                                                                 |
+| `logoutRoute`     | The route for the `logout` page.                                                                                                                                                                                                                                            |
+| `inactivityRoute` | The route for the `logout` inactivity page.                                                                                                                                                                                                                                 |
 
 ### The Admin User Collection
 
 <Banner type="warning">
   <strong>Important:</strong>
   <br />
-  The Payload Admin panel can only be used by one Collection that supports{" "}
-  <a href="/docs/authentication/overview">Authentication</a>.
+  The Payload Admin panel can only be used by one Collection that supports
+  [Authentication](/docs/authentication/overview).
 </Banner>
 
 To specify which Collection to use to log in to the Admin panel, pass the `admin` options a `user` key equal to the slug of the Collection that you'd like to use.
@@ -54,13 +62,13 @@ To specify which Collection to use to log in to the Admin panel, pass the `admin
 `payload.config.js`:
 
 ```ts
-import { buildConfig } from "payload/config";
+import { buildConfig } from 'payload/config'
 
 const config = buildConfig({
   admin: {
-    user: "admins", // highlight-line
+    user: 'admins', // highlight-line
   },
-});
+})
 ```
 
 By default, if you have not specified a Collection, Payload will automatically provide you with a `User` Collection which will be used to access the Admin panel. You can customize or override the fields and settings of the default `User` Collection by passing your own collection using `users` as its `slug` to Payload. When this is done, Payload will use your provided `User` Collection instead of its default version.

docs/admin/preferences.mdx

@@ -15,8 +15,10 @@ Out of the box, Payload handles the persistence of your users' preferences in a
 1. The "collapsed" state of blocks, on a document level, as users edit or interact with documents
 
 <Banner type="warning">
-	<strong>Important:</strong><br/>
-	All preferences are stored on an individual user basis. Payload automatically recognizes the user that is reading or setting a preference via all provided authentication methods.
+  <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
@@ -30,17 +32,17 @@ This API is used significantly for internal operations of the Admin panel, as me
 
 ### Database
 
-Payload automatically creates an internally used `_preferences` collection that stores user preferences. Each document in the `_preferences` collection contains the following shape:
+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`               | The ID of the `user` that is storing its preference. |
-| `userCollection`     | 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.
+| 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
 

docs/admin/vite.mdx

@@ -0,0 +1,82 @@
+---
+title: Vite
+label: Vite
+order: 90
+desc: NEEDS TO BE WRITTEN
+---
+
+Payload has a Vite bundler that you can install and bundle the Admin Panel with. This is an alternative to the [Webpack](/docs/admin/webpack) bundler and might give some performance boosts to your development workflow.
+
+To use Vite as your bundler, first you need to install the package:
+
+```bash
+yarn add @payloadcms/bundler-vite
+```
+
+<Banner>
+  The Vite bundler is currently in beta. If you would like to help us test this package, we'd love to hear if you find any bugs or issues!
+</Banner>
+
+Vite works fundamentally differently than Webpack. In development mode, it will first pre-bundle any of your dependencies that are CommonJS-only, and then it'll leverage ESM directly in your browser for a better HMR experience.
+
+It then uses Rollup to create production builds of your admin UI. With Vite, you should see a decent performance boost—especially after your first cold start. However, that first cold start might take a few more seconds.
+
+<Banner type="warning">
+  In most cases, Vite should work out of the box. But existing Payload plugins may need to make compatibility changes to support Vite.
+</Banner>
+
+This is because Vite aliases work fundamentally differently than Webpack aliases, and Payload relies on aliasing server-only code out of the Payload config to ensure that the bundled admin JS works within your browser.
+
+Here are the main differences between how Vite aliases work and how Webpack aliases work.
+
+**Vite aliases do not work with absolute paths.** 
+
+In Vite, an alias will only match if the `find` property _exactly matches_ how you are importing your server-only file. So if you are importing a file with a relative path, i.e. `'../../my-module'`, and your alias is absolute, your alias will not work.
+
+
+**Vite aliases do not get applied to pre-bundled dependencies.**
+
+This especially affects plugins, as plugins will be pre-bundled by Vite using `esbuild`. To get around this and support Vite, plugin authors need to configure an alias to their plugin at the top level, so that the alias will work accordingly.
+
+Here's an example. Say your plugin is called `payload-plugin-cool`. It's imported as follows:
+
+```ts
+import { myCoolPlugin } from 'payload-plugin-cool'
+```
+
+That plugin should create an alias to support Vite as follows:
+
+```ts
+{
+  // aliases go here
+  'payload-plugin-cool': path.resolve(__dirname, './my-admin-plugin.js')
+}
+
+```
+
+This will effectively alias the entire plugin and work with Vite. If the plugin requires admin-specific code, then the `./my-admin-plugin.js` alias target file should reflect any changes necessary to the admin UI that the main server-side plugin performs.
+
+### Extending the Vite config
+
+The Payload config supports a new property for plugins to be able to extend the Vite config specifically. That property exists on the main Payload config under `admin.vite`. 
+
+It's a function that takes a Vite config, and returns an updated Vite config. Here's an example:
+
+```ts
+export const buildConfig({
+  collections: [],
+  admin: {
+    vite: (incomingViteConfig) => ({
+      ...incomingViteConfig,
+      resolve: {
+        ...incomingViteConfig.resolve,
+        // Do whatever you need here 
+      }
+    })
+  }
+})
+```
+
+Even though there is a new property for Vite configs specifically, we have implemented some "compatibility" between Webpack and Vite out-of-the-box.
+
+If your config specifies Webpack aliases, we attempt to leverage them automatically within the Vite config. They are merged into the Vite alias configuration seamlessly and may work out-of-the-box.

docs/admin/webpack.mdx

@@ -1,178 +1,67 @@
 ---
 title: Webpack
 label: Webpack
-order: 60
+order: 80
 desc: The Payload admin panel uses Webpack 5 and supports many common functionalities such as SCSS and Typescript out of the box to give you more freedom.
 keywords: admin, webpack, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-Payload uses Webpack 5 to build the Admin panel. It comes with support for many common functionalities such as SCSS and Typescript out of the box, but there are many cases where you may need to add support for additional functionalities.
+Payload has a Webpack (v5) bundler that you can build the Admin panel with. For now, we recommended using it because it is stable. If you are feeling a bit more adventurous you can give the [Vite](/docs/admin/vite) bundler a shot.
 
-To extend the Webpack config, add the `webpack` key to your base Payload config, and provide a function that accepts the default Webpack config as its only argument:
+Out of the box, the Webpack bundler supports common functionalities such as SCSS and Typescript, but there are many cases where you may need to add support for additional functionalities.
+
+#### Installation
+
+```bash
+yarn add @payloadcms/bundler-webpack
+```
+
+#### Import the bundler
 
-`payload.config.ts`
 ```ts
-import { buildConfig } from 'payload/config';
+// payload.config.ts
+
+import { buildConfig } from 'payload/config'
+import { webpackBundler } from '@payloadcms/bundler-webpack'
 
 export default buildConfig({
-	admin: {
-		// highlight-start
-		webpack: (config) => {
-			// Do something with the config here
-
-			return config;
-		}
-		// highlight-end
-	}
-});
+  // highlight-start
+  admin: {
+    bundler: webpackBundler()
+  },
+  // highlight-end
+})
 ```
 
-### Aliasing server-only modules
+### Extending Webpack
 
-A common use case for extending the Payload config is to alias server-only modules, thus preventing them from inclusion into the browser JavaScript bundle.
+If you need to extend the Webpack config, you can do so by passing a function to the `admin.webpack` property on your Payload config.
+The function will receive the Webpack config as an argument and should return the modified config.
 
-As the Payload config is used in both server **and** client contexts, you may find yourself writing code in your Payload config that may be incompatible with browser environments.
-
-Examples of **non** browser-friendly packages:
-
-- `fs`
-- `stripe`
-- `authorizenet`
-- `nodemailer`
-
-You may rely on server-only packages such as the above to perform logic in access control functions, hooks, and other contexts (which is great!) but when you boot up your Payload app and try to view it in the browser, you'll likely run into missing dependency issues or other general incompatibilities.
-
-<Banner type="success">
-	<strong>Tip:</strong><br/>
-	To avoid problems with server code making it to your Webpack bundle, you can use the <strong>alias</strong> Webpack feature to tell Webpack to avoid importing the modules you want to restrict to server-only.
-</Banner>
-
-<strong>For example, let's say that you have a Collection called `Subscriptions` which relies on Stripe:</strong>
-
-<br/><br/>
-
-`collections/Subscriptions/index.js`
 ```ts
-import { CollectionConfig } from 'payload/types';
-import createStripeSubscription from './hooks/createStripeSubscription';
+// payload.config.ts
 
-const Subscription: CollectionConfig = {
-	slug: 'subscriptions',
-	hooks: {
-		beforeChange: [
-			createStripeSubscription,
-		]
-	},
-	fields: [
-		{
-			name: 'stripeSubscriptionID',
-			type: 'text',
-			required: true,
-		}
-	]
-};
-
-export default Subscription;
-```
-
-The collection above features a `beforeChange` hook that creates a Stripe subscription whenever a Subscription document is created in Payload.
-
-<strong>That hook might look something like this:</strong>
-
-<br/><br/>
-
-`collections/Subscriptions/hooks/createStripeSubscription.js`
-```js
-import Stripe from 'stripe';
-
-const stripe = new Stripe(process.env.STRIPE_SECRET_KEY);
-
-const createStripeSubscription = async ({ data, operation }) => {
-	if (operation === 'create') {
-		const dataWithStripeID = {...data};
-
-		// use Stripe to create a Stripe subscription
-		const subscription = await stripe.subscriptions.create({
-			// Configure the subscription accordingly
-		});
-
-		// Automatically add the Stripe subscription ID
-		// to the data that will be saved to this Subscription doc
-    dataWithStripeID.stripeSubscriptionID = subscription.id;
-
-    return dataWithStripeID
-	}
-
-	return data;
-}
-
-export default createStripeSubscription;
-```
-
-<Banner type="error">
-	<strong>Warning:</strong><br/>
-	The above code is NOT production-ready and should not be referenced to create Stripe subscriptions. Although creating a beforeChange hook is a completely valid spot to do things like create subscriptions, the code above is incomplete and insecure, meant for explanation purposes only.
-</Banner>
-
-**As-is, this collection will prevent your Admin panel from bundling or loading correctly, because Stripe relies on some Node-only packages.**
-
-To remedy this issue you can extend the Payload Webpack config to alias your entire `createStripeSubscription` hook to a separate, empty mock file.
-
-Example in `payload.config.js`:
-```js
-import { buildConfig } from 'payload/config';
-import path from 'path';
-import Subscription from './collections/Subscription';
-
-const createStripeSubscriptionPath = path.resolve(__dirname, 'collections/Subscription/hooks/createStripeSubscription.js');
-const mockModulePath = path.resolve(__dirname, 'mocks/emptyObject.js');
+import { buildConfig } from 'payload/config'
+import { webpackBundler } from '@payloadcms/bundler-webpack'
 
 export default buildConfig({
-	collections: [
-		Subscription
-	],
-	admin: {
-		webpack: (config) => ({
-			...config,
-			resolve: {
-				...config.resolve,
-				alias: {
-					...config.resolve.alias,
-					[createStripeSubscriptionPath]: mockModulePath,
-				}
-			}
-		})
-	}
-});
+  admin: {
+    bundler: webpackBundler()
+    // highlight-start
+    webpack: (config) => {
+      // full control of the Webpack config
+
+      return config
+    },
+    // highlight-end
+  },
+})
 ```
 
-The above code will alias the file at path `createStripeSubscriptionPath` to a mocked module, which might look like this:
-
-`mocks/emptyObject.js`
-```js
-export default {};
-```
-
-Now, when Webpack sees that you're attempting to import your `createStripeSubscriptionPath` file, it'll disregard that actual file and load your mock file instead. Not only will your Admin panel now bundle successfully, you will have optimized its filesize by removing unnecessary code! And you might have learned something about Webpack, too.
-
 <Banner type="success">
-	<strong>Tip:</strong><br/>
-	If changes to your Webpack aliases are not surfacing, they might be [cached](https://webpack.js.org/configuration/cache/) in `node_modules/.cache/webpack`. Try deleting that folder and restarting your server.
+  <strong>Tip:</strong>
+  <br />
+  If changes to your Webpack aliases are not surfacing, they might be
+  [cached](https://webpack.js.org/configuration/cache/) in `node_modules/.cache/webpack`. Try
+  deleting that folder and restarting your server.
 </Banner>
-
-## Admin environment vars
-
-<Banner type="warning">
-	<strong>Important:</strong><br />
-	Be careful about what variables you provide to your client-side code. Analyze every single one to make sure that you're not accidentally leaking anything that an attacker could exploit. Only keys that are safe to be available to everyone in plain text should be provided to your Admin panel.
-</Banner>
-
-By default, `env` variables are **not** provided to the Admin panel for security and safety reasons. But, Payload provides you with a way to still provide `env` vars to your frontend code.
-
-**Payload will automatically supply any present `env` variables that are prefixed with `PAYLOAD_PUBLIC_` directly to the Admin panel.**
-
-For example, if you've got the following environment variable:
-
-`PAYLOAD_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXX`
-
-This key will automatically be made available to the Payload bundle and can be referenced in your Admin component code as `process.env.PAYLOAD_PUBLIC_STRIPE_PUBLISHABLE_KEY`.

docs/authentication/config.mdx

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

docs/authentication/operations.mdx

@@ -17,6 +17,7 @@ The Access operation returns what a logged in user can and can't do with the col
 `GET http://localhost:3000/api/access`
 
 Example response:
+
 ```ts
 {
   canAccessAdmin: true,
@@ -77,6 +78,7 @@ Returns either a logged in user with token or null when there is no logged in us
 `GET http://localhost:3000/api/[collection-slug]/me`
 
 Example response:
+
 ```ts
 {
   user: { // The JWT "payload" ;) from the logged in user
@@ -108,6 +110,7 @@ query {
 Accepts an `email` and `password`. On success, it will return the logged in user as well as a token that can be used to authenticate. In the GraphQL and REST APIs, this operation also automatically sets an HTTP-only cookie including the user's token. If you pass an Express `res` to the Local API operation, Payload will set a cookie there as well.
 
 **Example REST API login**:
+
 ```ts
 const res = await fetch('http://localhost:3000/api/[collection-slug]/login', {
   method: 'POST',
@@ -117,10 +120,10 @@ const res = await fetch('http://localhost:3000/api/[collection-slug]/login', {
   body: JSON.stringify({
     email: 'dev@payloadcms.com',
     password: 'this-is-not-our-password...or-is-it?',
-  })
+  }),
 })
 
-const json = await res.json();
+const json = await res.json()
 
 // JSON will be equal to the following:
 /*
@@ -168,6 +171,7 @@ const result = await payload.login({
 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',
@@ -194,6 +198,7 @@ This operation requires a non-expired token to send back a new one. If the user'
 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',
@@ -202,7 +207,7 @@ const res = await fetch('http://localhost:3000/api/[collection-slug]/refresh-tok
   },
 })
 
-const json = await res.json();
+const json = await res.json()
 
 // JSON will be equal to the following:
 /*
@@ -233,7 +238,10 @@ mutation {
 ```
 
 <Banner type="success">
-  The Refresh operation will automatically find the user's token in either a JWT header or the HTTP-only cookie. But, you can specify the token you're looking to refresh by providing the REST API with a `token` within the JSON body of the request, or by providing the GraphQL resolver a `token` arg.
+  The Refresh operation will automatically find the user's token in either a JWT header or the
+  HTTP-only cookie. But, you can specify the token you're looking to refresh by providing the REST
+  API with a `token` within the JSON body of the request, or by providing the GraphQL resolver a
+  `token` arg.
 </Banner>
 
 ### Verify by Email
@@ -241,13 +249,14 @@ mutation {
 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**:
@@ -274,6 +283,7 @@ If a user locks themselves out and you wish to deliberately unlock them, you can
 To restrict who is allowed to unlock users, you can utilize the [`unlock`](/docs/access-control/overview#unlock) access control function.
 
 **Example REST API unlock**:
+
 ```ts
 const res = await fetch(`http://localhost:3000/api/[collection-slug]/unlock`, {
   method: 'POST',
@@ -308,6 +318,7 @@ The link to reset the user's password contains a token which is what allows the
 By default, the Forgot Password operations send users to the Payload Admin panel to reset their password, but you can customize the generated email to send users to the frontend of your app instead by [overriding the email HTML](/docs/authentication/config#forgot-password).
 
 **Example REST API Forgot Password**:
+
 ```ts
 const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-password`, {
   method: 'POST',
@@ -317,7 +328,7 @@ const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-pass
   body: JSON.stringify({
     email: 'dev@payloadcms.com',
   }),
-});
+})
 ```
 
 **Example GraphQL Mutation**:
@@ -336,13 +347,18 @@ const token = await payload.forgotPassword({
   data: {
     email: 'dev@payloadcms.com',
   },
-  disableEmail: false // you can disable the auto-generation of email via local API
-});
+  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.
+  <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
@@ -350,6 +366,7 @@ const token = await payload.forgotPassword({
 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',

docs/authentication/overview.mdx

@@ -6,14 +6,20 @@ desc: Payload provides highly secure user Authentication out of the box, and you
 keywords: authentication, config, configuration, overview, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
+<YouTube
+  id="CT4KafeJjTI"
+  title="Simplified Authentication for Headless CMS: Unlocking Reusability in One Line"
+/>
+
 <Banner>
-  Payload provides for highly secure and customizable user Authentication out of the box, which allows for users to identify themselves to Payload.
+  Payload provides for highly secure and customizable user Authentication out of the box, which
+  allows for users to identify themselves to Payload.
 </Banner>
 
 Authentication is used within the Payload Admin panel itself as well as throughout your app(s) themselves however you determine necessary.
 
 ![Authentication admin panel functionality](https://payloadcms.com/images/docs/auth-admin.jpg)
-*Admin panel screenshot depicting an Admins Collection with Auth enabled*
+_Admin panel screenshot depicting an Admins Collection with Auth enabled_
 
 **Here are some common use cases of Authentication outside of Payload's dashboard itself:**
 
@@ -33,10 +39,10 @@ Every Payload Collection can opt-in to supporting Authentication by specifying t
 Simple example collection:
 
 ```ts
-import { CollectionConfig } from 'payload/types';
+import { CollectionConfig } from 'payload/types'
 
-const Admins: CollectionConfig = {
-  slug:
+export const Admins: CollectionConfig = {
+  slug: 'admins',
   // highlight-start
   auth: {
     tokenExpiration: 7200, // How many seconds to keep the user logged in
@@ -57,7 +63,7 @@ const Admins: CollectionConfig = {
         'editor',
         'developer',
       ],
-    }
+    },
   ],
 }
 ```
@@ -78,9 +84,14 @@ Once enabled, each document that is created within the Collection can be thought
 
 Successfully logging in returns a `JWT` (JSON web token) which is how a user will identify themselves to Payload. By providing this JWT via either an HTTP-only cookie or an `Authorization` header, Payload will automatically identify the user and add its user JWT data to the Express `req`, which is available throughout Payload including within access control, hooks, and more.
 
+You can specify what data gets encoded to the JWT token by setting `saveToJWT` to true in your auth collection fields. If you wish to use a different key other than the field `name`, you can provide it to `saveToJWT` as a string. It is also possible to use `saveToJWT` on fields that are nested in inside groups and tabs. If a group has a `saveToJWT` set it will include the object with all sub-fields in the token. You can set `saveToJWT: false` for any fields you wish to omit. If a field inside a group has `saveToJWT` set, but the group does not, the field will be included at the top level of the token.
+
 <Banner type="success">
-  <strong>Tip:</strong><br/>
-  You can access the logged in user from access control functions and hooks via the Express <strong>req</strong>. The logged in user is automatically added as the <strong>user</strong> property.
+  <strong>Tip:</strong>
+  <br />
+  You can access the logged-in user from access control functions and hooks via the Express{' '}
+  <strong>req</strong>. The logged-in user is automatically added as the <strong>user</strong>{' '}
+  property.
 </Banner>
 
 ### HTTP-only cookies
@@ -100,16 +111,19 @@ Fetch example, including credentials:
 ```ts
 const response = await fetch('http://localhost:3000/api/pages', {
   credentials: 'include',
-});
+})
 
-const pages = await response.json();
+const pages = await response.json()
 ```
 
 For more about how to automatically include cookies in requests from your app to your Payload API, [click here](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Sending_a_request_with_credentials_included).
 
 <Banner type="success">
-  <strong>Tip:</strong><br/>
-  To make sure you have a Payload cookie set properly in your browser after logging in, you can use Chrome's Developer Tools - Application - Cookies - [your-domain-here]. The Chrome Developer tools will still show HTTP-only cookies, even when JavaScript running on the page can't.
+  <strong>Tip:</strong>
+  <br />
+  To make sure you have a Payload cookie set properly in your browser after logging in, you can use
+  Chrome's Developer Tools - Application - Cookies - [your-domain-here]. The Chrome Developer tools
+  will still show HTTP-only cookies, even when JavaScript running on the page can't.
 </Banner>
 
 ### CSRF Protection
@@ -121,28 +135,33 @@ For example, let's say you have a very popular app running at coolsite.com. This
 So, if a user of coolsite.com is logged in and just browsing around on the internet, they might stumble onto a page with bad intentions. That bad page might automatically make requests to all sorts of sites to see if they can find one that they can log into - and coolsite.com might be on their list. If your user was logged in while they visited that evil site, the attacker could do whatever they wanted as if they were your coolsite.com user by just sending requests to the coolsite API (which would automatically include the auth cookie). They could send themselves a bunch of money from your user's account, change the user's password, etc. This is what a CSRF attack is.
 
 <Banner type="warning">
-  <strong>To protect against CSRF attacks, Payload only accepts cookie-based authentication from domains that you explicitly whitelist.</strong>
+  <strong>
+    To protect against CSRF attacks, Payload only accepts cookie-based authentication from domains
+    that you explicitly whitelist.
+  </strong>
 </Banner>
 
 To define domains that should allow users to identify themselves via the Payload HTTP-only cookie, use the `csrf` option on the base Payload config to whitelist domains that you trust.
 
 `payload.config.ts`:
+
 ```ts
-import { buildConfig } from 'payload/config';
+import { buildConfig } from 'payload/config'
 
 const config = buildConfig({
   collections: [
     // collections here
   ],
   // highlight-start
-  csrf: [ // whitelist of domains to allow cookie auth from
+  csrf: [
+    // whitelist of domains to allow cookie auth from
     'https://your-frontend-app.com',
     'https://your-other-frontend-app.com',
   ],
   // highlight-end
-});
+})
 
-export default config;
+export default config
 ```
 
 ### Identifying users via the Authorization Header
@@ -150,11 +169,12 @@ export default config;
 In addition to authenticating via an HTTP-only cookie, you can also identify users via the `Authorization` header on an HTTP request.
 
 Example:
+
 ```ts
 const request = await fetch('http://localhost:3000', {
   headers: {
-    Authorization: `JWT ${token}`
-  }
+    Authorization: `JWT ${token}`,
+  },
 })
 ```
 

docs/authentication/using-middleware.mdx

@@ -11,38 +11,46 @@ Because Payload uses your existing Express server, you are free to add whatever
 This approach has a ton of benefits - it's great for isolation of concerns and limiting scope, but it also means that your additional routes won't have access to Payload's user authentication.
 
 <Banner type="success">
-  You can make full use of Payload's built-in authentication within your own custom Express endpoints by adding Payload's authentication middleware.
+  You can make full use of Payload's built-in authentication within your own custom Express
+  endpoints by adding Payload's authentication middleware.
+</Banner>
+
+<Banner type="warning">
+  Payload must be initialized before the `payload.authenticate` middleware can be used. This is done
+  by calling `payload.init()` prior to adding the middleware.
 </Banner>
 
 Example in `server.js`:
+
 ```ts
-import express from 'express';
-import payload from 'payload';
+import express from 'express'
+import payload from 'payload'
 
-const app = express();
+const app = express()
 
-payload.init({
-  secret: 'PAYLOAD_SECRET_KEY',
-  mongoURL: 'mongodb://localhost/payload',
-  express: app,
-});
+const start = async () => {
+  await payload.init({
+    secret: 'PAYLOAD_SECRET_KEY',
+    express: app,
+  })
 
-const router = express.Router();
+  const router = express.Router()
 
-router.use(payload.authenticate); // highlight-line
+  // Note: Payload must be initialized before the `payload.authenticate` middleware can be used
+  router.use(payload.authenticate) // highlight-line
 
-router.get('/', (req, res) => {
-  if (req.user) {
-    return res.send(`Authenticated successfully as ${req.user.email}.`);
-  }
+  router.get('/', (req, res) => {
+    if (req.user) {
+      return res.send(`Authenticated successfully as ${req.user.email}.`)
+    }
 
-  return res.send('Not authenticated');
-});
+    return res.send('Not authenticated')
+  })
 
-app.use('/some-route-here', router);
+  app.use('/some-route-here', router)
 
-app.listen(3000, async () => {
-  payload.logger.info(`listening on ${3000}...`);
-});
+  app.listen(3000)
+}
 
+start()
 ```

docs/cloud/configuration.mdx

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

docs/cloud/creating-a-project.mdx

@@ -0,0 +1,51 @@
+---
+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

@@ -0,0 +1,109 @@
+---
+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.
+
+### Build Settings
+
+You can update settings from your Project’s Settings tab. Changes to your build settings will trigger a redeployment of your project.
+
+### Environment Variables
+
+From the Environment Variables page of the Settings tab, you can add, update and delete variables for use in your project. Like build settings, these changes will trigger a redeployment of your project.
+
+<Banner>
+  Note: For security reasons, any variables you wish to provide to the Admin panel must be prefixed
+  with `PAYLOAD_PUBLIC_`.  Learn more
+  [here](https://payloadcms.com/docs/admin/webpack#admin-environment-vars).
+</Banner>
+
+### Custom Domains
+
+With Payload Cloud, you can add custom domain names to your project. To do so, first go to the Domains page of the Settings tab of your project. Here you can see your default domain. To add a new domain, type in the domain name you wish to use.
+
+<Banner>
+  Note: do not include the protocol (http:// or https://) or any paths (/page). Only include the
+  domain name and extension, and optionally a subdomain. - your-domain.com - backend.your-domain.com
+</Banner>
+
+Once you click save, a DNS record will be generated for your domain name to point to your live project. Add this record into your DNS provider’s records, and once the records are resolving properly (this can take 1hr to 48hrs in some cases), your domain will now to point to your live project.
+
+You will also need to configure your Payload project to use your specified domain. In your `payload.config.ts` file, specify your `serverURL` with your domain:
+
+```ts
+export default buildConfig({
+  serverURL: 'https://example.com',
+  // the rest of your config,
+})
+```
+
+### Email
+
+Powered by [Resend](https://resend.com), Payload Cloud comes with integrated email support out of the box. No configuration is needed, and you can use `payload.sendEmail()` to send email right from your Payload app. To learn more about sending email with Payload, checkout the [Email Configuration](https://payloadcms.com/docs/email/overview) overview.
+
+If you are on the Pro or Enterprise plan, you can add your own custom Email domain name. From the Email page of your project’s Settings, add the domain you wish to use for email delivery. This will generate a set of DNS records. Add these records to your DNS provider and click verify to check that your records are resolving properly. Once verified, your emails will now be sent from your custom domain name.
+
+### Developing Locally
+
+To make changes to your project, you will need to clone the repository defined in your project settings to your local machine. In order to run your project locally, you will need configure your local environment first. Refer to your repository’s `README.md` file to see the steps needed for your specific template.
+
+From there, you are ready to make updates to your project. When you are ready to make your changes live, commit your changes to the branch you specified in your Project settings, and your application will automatically trigger a redeploy and build from your latest commit.
+
+### Cloud Plugin
+
+Projects generated from a template will come pre-configured with the official Cloud Plugin, but if you are using your own repository you will need to add this into your project. To do so, add the plugin to your Payload config:
+
+`yarn add @payloadcms/plugin-cloud`
+
+```js
+import { payloadCloud } from '@payloadcms/plugin-cloud'
+import { buildConfig } from 'payload/config'
+
+export default buildConfig({
+  plugins: [payloadCloud()],
+  // rest of config
+})
+```
+
+<Banner type="warning">
+  **Note:** If your Payload config already has an email with transport, this will take precedence
+  over Payload Cloud's email service.
+</Banner>
+
+##### **Optional configuration**
+
+If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.
+
+```js
+payloadCloud({
+  storage: false, // Disable file storage
+  email: false, // Disable email delivery
+})
+```