chore(release): v1.9.4

fix: totalDocs is always 1 when using payload.find({ pagination: false })

.eslintrc.js

@@ -11,7 +11,7 @@ module.exports = {
     '@typescript-eslint',
   ],
   extends: [
-    '@trbl',
+    './eslint-config',
   ],
   settings: {
     'import/resolver': {
@@ -57,6 +57,7 @@ module.exports = {
           {
             ignore: [
               'payload-config',
+              'payload/generated-types',
             ],
           },
         ],

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -0,0 +1,42 @@
+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/master/.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: 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/reproduction-guide.md

@@ -0,0 +1,58 @@
+# 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/master/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/master/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/tests.yml

@@ -2,9 +2,9 @@ name: build
 
 on:
   pull_request:
-    types: [opened, reopened, edited, synchronize]
+    types: [opened, reopened, synchronize]
   push:
-    branches: ['master']
+    branches: ["master"]
 
 jobs:
   build_yarn:
@@ -14,47 +14,51 @@ jobs:
         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
+      - 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: 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 Payload Types
+        run: yarn dev:generate-types fields
 
-    - name: Install Playwright Browsers
-      run: npx playwright install --with-deps
-    - name: E2E Tests
-      run: yarn test:e2e --bail
+      - name: Generate GraphQL schema file
+        run: yarn dev:generate-graphql-schema graphql-schema-gen
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - name: E2E Tests
+        run: yarn test:e2e --bail
+
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: test-results
+          path: test-results/
+          retention-days: 30
 
-    # - uses: actions/upload-artifact@v2
-    #   if: always()
-    #   with:
-    #     name: playwright-report
-    #     path: playwright-report/
-    #     retention-days: 30
   install_npm:
     runs-on: ubuntu-latest
     strategy:
@@ -62,23 +66,23 @@ jobs:
         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 }}
+      - 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
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -2,6 +2,7 @@ coverage
 package-lock.json
 dist
 .idea
+test-results
 
 # Created by https://www.gitignore.io/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
 
@@ -163,7 +164,7 @@ GitHub.sublime-settings
 # CMake
 cmake-build-debug/
 
-# Mongo Explorer plugin:
+# MongoDB Explorer plugin:
 .idea/**/mongoSettings.xml
 
 ## File-based project format:

.nvmrc

@@ -0,0 +1 @@
+v16.14.2

.release-it.json

@@ -1,4 +1,5 @@
 {
+  "verbose": true,
   "git": {
     "commitMessage": "chore(release): v${version}",
     "requireCleanWorkingDir": true

.release-it.pre.json

@@ -1,5 +1,5 @@
 {
-  "preReleaseId": "beta",
+  "verbose": true,
   "git": {
     "requireCleanWorkingDir": false,
     "commit": false,
@@ -7,11 +7,11 @@
     "tag": false
   },
   "github": {
-    "release": false
+    "release": true
   },
   "npm": {
     "skipChecks": true,
-    "tag": "beta"
+    "tag": "canary"
   },
   "hooks": {
     "before:init": ["yarn", "yarn clean", "yarn test"]

.vscode/launch.json

@@ -5,42 +5,18 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "Debug Jest Tests",
-      "type": "node",
+      "command": "yarn run dev _community",
+      "name": "Run Dev Community",
       "request": "launch",
-      "runtimeArgs": [
-        "--inspect-brk",
-        "${workspaceRoot}/node_modules/.bin/jest",
-        "--runInBand"
-      ],
-      "env": {
-        "PAYLOAD_CONFIG_PATH": "demo/payload.config.ts"
-      },
-      "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen",
-      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/babel-node",
-      "port": 9229,
-      "skipFiles": [
-        "<node_internals>/**"
-      ]
+      "type": "node-terminal",
+      "cwd": "${workspaceFolder}"
     },
     {
-      "type": "node",
+      "command": "yarn run dev fields",
+      "name": "Run Dev Fields",
       "request": "launch",
-      "name": "Launch Program",
-      "env": {
-        "BABEL_ENV": "development"
-      },
-      "program": "${workspaceFolder}/test/dev.js",
-      "skipFiles": [
-        "<node_internals>/**"
-      ],
-      "runtimeArgs": [
-        "--nolazy"
-      ],
-      "args": [
-        "fields"
-      ]
+      "type": "node-terminal",
+      "cwd": "${workspaceFolder}"
     },
   ]
 }

ISSUE_GUIDE.md

@@ -0,0 +1,64 @@
+# 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 `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.
+
+## 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
+  yarn 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/master/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
+  ```
+
+### 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/master/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,30 +1,70 @@
-<h1 align="center">Payload</h1>
-<p align="center">A free and open-source TypeScript headless CMS & application framework built with Express, MongoDB and React.</p>
-<p align="center">
-  <a href="https://opensource.org/licenses/MIT">
-    <img src="https://img.shields.io/badge/License-MIT-blue.svg" />
-  </a>
-  <a href="https://github.com/payloadcms/payload/actions">
-    <img src="https://github.com/payloadcms/payload/workflows/build/badge.svg" />
-  </a>
-  <a href="https://www.npmjs.com/package/payload">
-    <img alt="npm" src="https://img.shields.io/npm/v/payload" />
-  </a>
-
-  <a href="https://twitter.com/intent/tweet?text=Payload%20-%20A%20self-hosted%2C%20headless%20JavaScript%20CMS%20%26%20application%20framework&url=https%3A%2F%2Fgithub.com%2Fpayloadcms%2Fpayload">
-  <img alt="Tweet Payload" src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social" />
-  </a>
-
-  <a href="https://discord.com/invite/r6sCXqVk3v">
-    <img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da" />
+<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 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>
+
+<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;
+  <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">
+  </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.gg/payload">
+    <img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da&style=flat-square" />
+  </a>
+  &nbsp;
+  <a href="https://www.npmjs.com/package/payload">
+    <img alt="npm" src="https://img.shields.io/npm/v/payload?style=flat-square" />
+  </a>
+  &nbsp;
+  <a href="https://twitter.com/payloadcms">
+    <img src="https://img.shields.io/badge/follow-payloadcms-1DA1F2?logo=twitter&style=flat-square" alt="Payload Twitter" />
+  </a>
+</p>
+
+<br />
+
 <a href="https://payloadcms.com">
-  <img src="https://payloadcms.com/images/og-image.jpg" alt="Payload headless CMS Admin panel built with React" />
+  <img src="https://cms.payloadcms.com/media/payload-github-header.jpg" alt="Payload headless CMS Admin panel built with React" />
 </a>
 
-### Features
+<br />
+
+## ⭐ Why Payload?
+
+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:
+
+- 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.
+
+<a target="_blank" href="https://payloadcms.com/" rel="dofollow"><strong>Read more on our website</strong></a>
+
+## ✨ Features
 
 - Completely free and open-source
 - [GraphQL](https://payloadcms.com/docs/graphql/overview), [REST](https://payloadcms.com/docs/rest-api/overview), and [Local](https://payloadcms.com/docs/local-api/overview) APIs
@@ -44,41 +84,56 @@
 - Intensely fast API
 - Highly secure thanks to HTTP-only cookies, CSRF protection, and more
 
-### Code-first
+<a target="_blank" href="https://github.com/payloadcms/payload/discussions"><strong>Request Feature</strong></a>
 
-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:
-
-- 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.
-
-### Quick Start
+## 🚀 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
+## 🗒️ 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.
 
-### Contributing
+## 🙋 Contributing
 
 If you want to add contributions to this repository, please follow the instructions in [contributing.md](./contributing.md).
 
-### Other Resources
+## 📚 Examples and Templates
 
-##### Discussions
+The examples directory is a great resource for learning how to setup Payload in a variety of different ways. There are also a number of templates to help get you going very quickly. If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find.
 
-There are lots of good conversations and resources in our [GitHub Discussions board](https://github.com/payloadcms/payload/discussions). If you're struggling with something, chances are, someone's already solved what you're up against. Searching Discussions will often provide very helpful tips and tricks.
+- [Examples Directory](./examples)
+- [Official Templates](https://github.com/orgs/payloadcms/repositories?q=topic%3Apayload-template)
+- [Community Templates](https://github.com/topics/payload-template)
 
-##### Discord
+## 🔌 Plugins
 
-Join [Payload's Discord channel](https://discord.com/invite/r6sCXqVk3v) to interact with Payload developers in realtime.
+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 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
+
+![payload-github-star](https://cms.payloadcms.com/media/payload-github-star.gif)
+
+## 👏 Thanks to all our contributors
+
+<img align="left" src="https://contributors-img.web.app/image?repo=payloadcms/payload"/>

babel.config.js

@@ -1,3 +0,0 @@
-const config = require('./src/babel.config');
-
-module.exports = config;

babel.js

@@ -1,3 +0,0 @@
-const babelConfig = require('./dist/babel.config');
-
-exports.config = babelConfig;

components/elements.js

@@ -0,0 +1,5 @@
+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/fields/Json.ts

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

components/forms.js

@@ -0,0 +1,42 @@
+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/hooks.js

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

components/icons.js

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

components/icons.ts

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

components/preferences.js

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

components/rich-text.js

@@ -0,0 +1,3 @@
+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/templates.js

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

components/utilities.js

@@ -0,0 +1,7 @@
+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;
+exports.useTheme = require('../dist/admin/components/utilities/Theme').useTheme;

components/views/Cell.js

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

components/views/Dashboard.js

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

components/views/Edit.js

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

components/views/List.js

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

components/views/List.ts

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

contributing.md

@@ -1,6 +1,6 @@
-# Contributing to Payload CMS
+# Contributing to Payload
 
-Below you'll find a set of guidelines for how to contribute to Payload CMS.
+Below you'll find a set of guidelines for how to contribute to Payload.
 
 ## Opening issues
 
@@ -22,7 +22,7 @@ If you're an incredibly awesome person and want to help us make Payload even bet
 
 ### 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.
+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
 
@@ -49,7 +49,11 @@ The directory split up in this way specifically to reduce friction when creating
 
 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`.
+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.
 

docs/access-control/collections.mdx

@@ -30,7 +30,7 @@ If a Collection supports [`Authentication`](/docs/authentication/overview), the
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Posts: CollectionConfig = {
+export const Posts: CollectionConfig = {
   slug: "posts",
   // highlight-start
   access: {
@@ -42,8 +42,6 @@ const Posts: CollectionConfig = {
   },
   // highlight-end
 };
-
-export default Categories;
 ```
 
 ### Create

docs/access-control/fields.mdx

@@ -20,7 +20,7 @@ Field Access Control is specified with functions inside a field's config. All fi
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Posts: CollectionConfig = {
+export const Posts: CollectionConfig = {
   slug: 'posts',
   fields: [
     {
@@ -67,6 +67,8 @@ Returns a boolean which allows or denies the ability to read a field's value. If
 
 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 |

docs/access-control/overview.mdx

@@ -38,7 +38,7 @@ const defaultPayloadAccess = ({ req: { 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>.
+  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

docs/admin/components.mdx

@@ -21,22 +21,22 @@ To swap in your own React component, first, consult the list of available compon
 
 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 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)                                                                                                          |
 
 #### Full example:
 
@@ -77,18 +77,115 @@ _For more examples regarding how to customize components, look at the following
 
 You can override components on a Collection-by-Collection basis via each Collection's `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                                                                                                            |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| **`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.                       |
+| **`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.                                                          |
+| **`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
+                                                         |
+| **`AfterListTable`**   | Array of components to inject _after_ the built-in List view's table
+                                                         |
+| **`AfterList`**   | Array of components to inject _after_ the built-in List view
+                                                         |
+#### Examples
+
+```tsx
+// Custom Buttons
+
+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} />;
+};
+```
+
+##### Custom Collection List View Example
+
+Collection.ts
+```tsx
+import { MyListComponent } from './MyListComponent';
+export const MyCollection: CollectionConfig = {
+  slug: 'mycollection',
+  admin: {
+    components: {
+      views: {
+        List: MyListComponent,
+      },
+    },
+  },
+  fields: [
+    ...
+  ],
+};
+```
+
+MyListComponent.tsx
+```tsx
+import React from 'react';
+import {List, type Props} from 'payload/components/views/List' // Payload's default List view component and its props
+export const MyListComponent: React.FC<Props> = (props) => (
+  <div>
+    <p>Some text before the default list view component. If you just want to do that, you can also use the admin.components.list.BeforeList hook</p>
+    <List {...props} />
+  </div>
+);
+```
 
 ### Globals
 
 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                                                                                                            |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| **`views.Edit`**           | Used while this Global is being edited.                                                                                |
+| **`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.                                                          |
 
 ### Fields
 
@@ -163,7 +260,11 @@ const CustomTextField: React.FC<Props> = ({ 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>.
+  build custom components, including the <strong>useField</strong> hook,{" "}
+  <a href="/docs/admin/hooks" style={{ color: "black" }}>
+    click here
+  </a>
+  .
 </Banner>
 
 ## Custom routes
@@ -232,19 +333,20 @@ 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>
   );
 };

docs/admin/hooks.mdx

@@ -166,7 +166,6 @@ The `useDocumentInfo` hook provides lots of information about the document curre
 |---------------------------|--------------------------------------------------------------------------------------------------------------------|                                |
 | **`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                                                                                        |
@@ -226,14 +225,15 @@ const Greeting: React.FC = () => {
 
 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';

docs/admin/overview.mdx

@@ -11,49 +11,54 @@ Payload dynamically generates a beautiful, fully functional React admin panel to
 The Payload Admin panel is built with Webpack, 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*
+_Screenshot of the Admin panel while editing a document from an example `AllFields` collection_
 
 ## 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) |
-| `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. |
+| 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.                                                                                                                                                         |
-
+| `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.                                                                                                                                                                                                                  |
 
 ### 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>.
+  <strong>Important:</strong>
+  <br />
+  The Payload Admin panel can only be used by one Collection that supports{" "}
+  <a href="/docs/authentication/overview">Authentication</a>.
 </Banner>
 
 To specify which Collection to use to log in to the Admin panel, pass the `admin` options a `user` key equal to the slug of the Collection that you'd like to use.
 
 `payload.config.js`:
+
 ```ts
-import { buildConfig } from 'payload/config';
+import { buildConfig } from "payload/config";
 
 const config = buildConfig({
   admin: {
-    user: 'admins', // highlight-line
+    user: "admins", // highlight-line
   },
 });
 ```

docs/admin/webpack.mdx

@@ -56,7 +56,7 @@ You may rely on server-only packages such as the above to perform logic in acces
 import { CollectionConfig } from 'payload/types';
 import createStripeSubscription from './hooks/createStripeSubscription';
 
-const Subscription: CollectionConfig = {
+export const Subscription: CollectionConfig = {
 	slug: 'subscriptions',
 	hooks: {
 		beforeChange: [
@@ -71,8 +71,6 @@ const Subscription: CollectionConfig = {
 		}
 	]
 };
-
-export default Subscription;
 ```
 
 The collection above features a `beforeChange` hook that creates a Stripe subscription whenever a Subscription document is created in Payload.

docs/authentication/config.mdx

@@ -43,22 +43,22 @@ To enable API keys on a collection, set the `useAPIKey` auth option to `true`. F
   is compromised, your API keys will not be.
 </Banner>
 
-##### Authenticating via API Key
+#### Authenticating via API Key
 
-To utilize your API key while interacting with the REST or GraphQL API, add the `Authorization` header.
+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.
 
 **For example, using Fetch:**
 
 ```ts
+import User from '../collections/User';
+
 const response = await fetch("http://localhost:3000/api/pages", {
   headers: {
-    Authorization: `${collection.labels.singular} API-Key ${YOUR_API_KEY}`,
+    Authorization: `${User.slug} API-Key ${YOUR_API_KEY}`,
   },
 });
 ```
 
-Note: The label portion of the header is case-sensitive and will likely have a capitalized first character unless the label has been customized.
-
 ### Forgot Password
 
 You can customize how the Forgot Password workflow operates with the following options on the `auth.forgotPassword` property:
@@ -82,7 +82,7 @@ Example:
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Customers: CollectionConfig = {
+export const Customers: CollectionConfig = {
   slug: 'customers',
   auth: {
     forgotPassword: {
@@ -156,7 +156,7 @@ Example:
 import { CollectionConfig } from 'payload/types';
 
 
-const Customers: CollectionConfig = {
+export const Customers: CollectionConfig = {
   slug: 'customers',
   auth: {
     verify: {

docs/authentication/operations.mdx

@@ -94,7 +94,7 @@ Example response:
 
 ```graphql
 query {
-  Me[collection-singular-label] {
+  me[collection-singular-label] {
     user {
       email
     }

docs/authentication/overview.mdx

@@ -35,8 +35,8 @@ Simple example collection:
 ```ts
 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

docs/authentication/using-middleware.mdx

@@ -11,38 +11,48 @@ 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();
 
-payload.init({
-  secret: 'PAYLOAD_SECRET_KEY',
-  mongoURL: 'mongodb://localhost/payload',
-  express: app,
-});
+const start = async () => {
+  await payload.init({
+    secret: "PAYLOAD_SECRET_KEY",
+    mongoURL: "mongodb://localhost/payload",
+    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/configuration/collections.mdx

@@ -12,21 +12,25 @@ It's often best practice to write your Collections in separate files and then im
 
 ## Options
 
-| Option           | Description                                                                                                                                                                                                              |
-|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`slug`** *     | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                          |
-| **`fields`** *   | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
-| **`labels`**     | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                           |
-| **`admin`**      | Admin-specific configuration. See below for [more detail](#admin-options).                                                                                                                                               |
-| **`hooks`**      | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/overview#collection-hooks)                                                                                                         |
-| **`access`**     | Provide access control functions to define exactly who should be able to do what with Documents in this Collection. [More](/docs/access-control/overview/#collections)                                                   |
-| **`auth`**       | Specify options if you would like this Collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation.                                                          |
-| **`upload`**     | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](/docs/upload/overview) documentation.                                                                         |
-| **`timestamps`** | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                                                       |
-| **`versions`**   | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#collection-config)                                                                                            |
-| **`endpoints`**  | Add custom routes to the REST API. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                                                      |
-| **`graphQL`**    | An object with `singularName` and `pluralName` strings used in schema generation. Auto-generated from slug if not defined.                                                                                               |
-| **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                      |
+| Option             | Description                                                                                                                                                                                                              |
+|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`slug`** *       | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                          |
+| **`fields`** *     | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
+| **`indexes`** *    | Array of database indexes to create, including compound indexes that have multiple fields.                                                                                                                               |
+| **`labels`**       | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                           |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-options).                                                                                                                                               |
+| **`hooks`**        | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/overview#collection-hooks)                                                                                                         |
+| **`access`**       | Provide access control functions to define exactly who should be able to do what with Documents in this Collection. [More](/docs/access-control/overview/#collections)                                                   |
+| **`auth`**         | Specify options if you would like this Collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation.                                                          |
+| **`upload`**       | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](/docs/upload/overview) documentation.                                                                         |
+| **`timestamps`**   | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                                                       |
+| **`versions`**     | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#collection-config)                                                                                            |
+| **`endpoints`**    | Add custom routes to the REST API. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                                                      |
+| **`graphQL`**      | An object with `singularName` and `pluralName` strings used in schema generation. Auto-generated from slug if not defined.                                                                                               |
+| **`typescript`**   | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                      |
+| **`defaultSort`**  | Pass a top-level field to sort by default in the collection List view. Prefix the name of the field with a minus symbol ("-") to sort in descending order.                                                               |
+| **`pagination`**   | Set pagination-specific options for this collection. [More](#pagination)                                                                                                                                                 |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -35,7 +39,7 @@ It's often best practice to write your Collections in separate files and then im
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Orders: CollectionConfig = {
+export const Orders: CollectionConfig = {
 	slug: 'orders',
 	fields: [
 		{
@@ -49,7 +53,7 @@ const Orders: CollectionConfig = {
 			relationTo: 'customers',
 			required: true,
 		}
-	]
+	],
 };
 ```
 
@@ -61,18 +65,21 @@ You can find an assortment of [example collection configs](https://github.com/pa
 
 You can customize the way that the Admin panel behaves on a collection-by-collection basis by defining the `admin` property on a collection's config.
 
-| Option                      | Description  |
-| --------------------------- | -------------|
-| `group`                     | Text used as a label for grouping collection links together in the navigation. |
-| `hooks`                     | Admin-specific hooks for this collection. [More](#admin-hooks) |
-| `useAsTitle`                | Specify a top-level field to use for a document title throughout the Admin panel. If no field is defined, the ID of the document is used as the title. |
-| `description`               | Text or React component to display below the Collection label in the List view to give editors more information. |
-| `defaultColumns`            | Array of field names that correspond to which columns to show by default in this collection's List view. |
-| `disableDuplicate `         | Disables the "Duplicate" button while editing documents within this collection. |
+| Option                       | Description                                                                                                                                                                                           |
+|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `group`                      | Text used as a label for grouping collection and global links together in the navigation.                                                                                                             |
+| `hidden`                     | Set to true or a function, called with the current user, returning true to exclude this collection from navigation and admin routing.                                                                 |
+| `hooks`                      | Admin-specific hooks for this collection. [More](#admin-hooks)                                                                                                                                        |
+| `useAsTitle`                 | Specify a top-level field to use for a document title throughout the Admin panel. If no field is defined, the ID of the document is used as the title.                                                |
+| `description`                | Text or React component to display below the Collection label in the List view to give editors more information.                                                                                      |
+| `defaultColumns`             | Array of field names that correspond to which columns to show by default in this collection's List view.                                                                                              |
+| `disableDuplicate `          | Disables the "Duplicate" button while editing documents within this collection.                                                                                                                       |
+| `hideAPIURL`                 | Hides the "API URL" meta field while editing documents within this collection.                                                                                                                        |
+| `enableRichTextLink`         | The [Rich Text](/docs/fields/rich-text) field features a `Link` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default.         |
 | `enableRichTextRelationship` | The [Rich Text](/docs/fields/rich-text) field features a `Relationship` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
-| `preview`                   | Function to generate preview URLS within the Admin panel that can point to your app. [More](#preview). |
-| `components`                | Swap in your own React components to be used within this collection. [More](/docs/admin/components#collections) |
-| `listSearchableFields`      | Specify which fields should be searched in the List search view. [More](#list-searchable-fields) |
+| `preview`                    | Function to generate preview URLS within the Admin panel that can point to your app. [More](#preview).                                                                                                |
+| `components`                 | Swap in your own React components to be used within this collection. [More](/docs/admin/components#collections)                                                                                       |
+| `listSearchableFields`       | Specify which fields should be searched in the List search view. [More](#list-searchable-fields)                                                                                                      |
 
 ### Preview
 
@@ -90,7 +97,7 @@ If the function is specified, a Preview button will automatically appear in the
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Posts: CollectionConfig = {
+export const Posts: CollectionConfig = {
 	slug: 'posts',
 	fields: [
 		{
@@ -111,6 +118,15 @@ const Posts: CollectionConfig = {
 };
 ```
 
+### Pagination
+
+Here are a few options that you can specify options for pagination on a collection-by-collection basis:
+
+| Option                      | Description  |
+| --------------------------- | -------------|
+| `defaultLimit`              | Integer that specifies the default per-page limit that should be used. Defaults to 10. |
+| `limits`                    | Provide an array of integers to use as per-page options for admins to choose from in the List view. |
+
 ### Access control
 
 You can specify extremely granular access control (what users can do with documents in a collection) on a collection by collection basis. To learn more, go to the [Access Control](/docs/access-control/overview) docs.

docs/configuration/express.mdx

@@ -8,6 +8,40 @@ keywords: config, configuration, documentation, Content Management System, cms,
 
 Payload utilizes a few Express-specific middleware packages within its own routers. You can customize how they work by passing in configuration options to the main Payload config's `express` property.
 
+### Custom Middleware
+
+Payload allows you to pass in custom Express middleware to be used on all of the routes it opens. This is useful for adding logging or any other custom functionality to your endpoints.
+
+There are 2 exposed properties. Each property is an array of middleware functions.
+
+- `preMiddleware` - runs before any of the Payload middleware
+- `postMiddleware` - runs after all of the Payload middleware
+
+```ts
+{
+  express: {
+    preMiddleware: [
+      (req, res, next) => {
+        // do something
+        next()
+      }
+    ],
+    postMiddleware: [
+      (req, res, next) => {
+        // do something
+        next()
+      }
+    ]
+  }
+}
+
+// Example logging middleware function
+const requestLoggerMiddleware = (req, res, next) => {
+  req.payload.logger.info(`request: ${req.method} ${req.url}`)
+  next()
+}
+```
+
 ### JSON
 
 `express.json()` is used to parse JSON body content into JavaScript objects accessible on the Express `req`. Payload allows you to customize all of the `json` method's options. Common examples of customization use-cases are increasing the max allowed JSON body size which defaults to `2MB`.

docs/configuration/globals.mdx

@@ -6,16 +6,16 @@ desc: Set up your Global config for your needs by defining fields, adding slugs
 keywords: globals, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-Global configs are in many ways similar to [Collections](/docs/configuration/collections). The big difference is that Collections will potentially contain *many* documents, while a Global is a "one-off". Globals are perfect for things like header nav, site-wide banner alerts, app-wide localized strings, and other "global" data that your site or app might rely on.
+Global configs are in many ways similar to [Collections](/docs/configuration/collections). The big difference is that Collections will potentially contain _many_ documents, while a Global is a "one-off". Globals are perfect for things like header nav, site-wide banner alerts, app-wide localized strings, and other "global" data that your site or app might rely on.
 
 As with Collection configs, it's often best practice to write your Globals in separate files and then import them into the main Payload config.
 
 ## Options
 
 | Option             | Description                                                                                                                                                                                                          |
-|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`slug`** *       | Unique, URL-friendly string that will act as an identifier for this Global.                                                                                                                                          |
-| **`fields`** *     | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
+| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`slug`** \*      | Unique, URL-friendly string that will act as an identifier for this Global.                                                                                                                                          |
+| **`fields`** \*    | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
 | **`label`**        | Text for the name in the Admin panel or an object with keys for each language. Auto-generated from slug if not defined.                                                                                              |
 | **`description`**  | Text or React component to display below the Global header to give editors more information.                                                                                                                         |
 | **`admin`**        | Admin-specific configuration. See below for [more detail](/docs/configuration/globals#admin-options).                                                                                                                |
@@ -24,33 +24,34 @@ As with Collection configs, it's often best practice to write your Globals in se
 | **`versions`**     | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#globals-config)                                                                                           |
 | **`endpoints`**    | Add custom routes to the REST API. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                                                  |
 | **`graphQL.name`** | Text used in schema generation. Auto-generated from slug if not defined.                                                                                                                                             |
-| **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                  |
+| **`typescript`**   | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                  |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                            |
 
-*\* An asterisk denotes that a property is required.*
+_\* An asterisk denotes that a property is required._
 
 #### Simple Global example
 
 ```ts
-import { GlobalConfig } from 'payload/types';
+import { GlobalConfig } from "payload/types";
 
 const Nav: GlobalConfig = {
-	slug: 'nav',
-	fields: [
-		{
-			name: 'items',
-			type: 'array',
-			required: true,
-			maxRows: 8,
-			fields: [
-				{
-					name: 'page',
-					type: 'relationship',
-					relationTo: 'pages', // "pages" is the slug of an existing collection
-					required: true,
-				}
-			]
-		},
-	]
+  slug: "nav",
+  fields: [
+    {
+      name: "items",
+      type: "array",
+      required: true,
+      maxRows: 8,
+      fields: [
+        {
+          name: "page",
+          type: "relationship",
+          relationTo: "pages", // "pages" is the slug of an existing collection
+          required: true,
+        },
+      ],
+    },
+  ],
 };
 
 export default Nav;
@@ -64,9 +65,50 @@ You can find an [example Global config](https://github.com/payloadcms/public-dem
 
 You can customize the way that the Admin panel behaves on a Global-by-Global basis by defining the `admin` property on a Global's config.
 
-| Option                       | Description  |
-| ---------------------------- | -------------|
-| `components`                 | Swap in your own React components to be used within this Global. [More](/docs/admin/components#globals) |
+| Option       | Description                                                                                                                       |
+|--------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| `group`      | Text used as a label for grouping collection and global links together in the navigation.                                                    |
+| `hidden`     | Set to true or a function, called with the current user, returning true to exclude this global from navigation and admin routing. |
+| `components` | Swap in your own React components to be used within this Global. [More](/docs/admin/components#globals)                           |
+| `preview`    | Function to generate a preview URL within the Admin panel for this global that can point to your app. [More](#preview).           |
+| `hideAPIURL` | Hides the "API URL" meta field while editing documents within this collection.                                                    |
+
+### Preview
+
+Global `admin` options can accept a `preview` function that will be used to generate a link pointing to the frontend of your app to preview data.
+
+If the function is specified, a Preview button will automatically appear in the corresponding global's Edit view. Clicking the Preview button will link to the URL that is generated by the function.
+
+**The preview function accepts two arguments:**
+
+1. The document being edited
+1. An `options` object, containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT.
+
+**Example global with preview function:**
+
+```ts
+import { GlobalConfig } from "payload/types";
+
+export const MyGlobal: GlobalConfig = {
+  slug: "my-global",
+  fields: [
+    {
+      name: "slug",
+      type: "text",
+      required: true,
+    },
+  ],
+  admin: {
+    preview: (doc, { locale }) => {
+      if (doc?.slug) {
+        return `https://bigbird.com/preview/${doc.slug}?locale=${locale}`;
+      }
+
+      return null;
+    },
+  },
+};
+```
 
 ### Access control
 
@@ -85,14 +127,14 @@ Globals support all field types that Payload has to offer—including simple fie
 You can import global types as follows:
 
 ```ts
-import { GlobalConfig } from 'payload/types';
+import { GlobalConfig } from "payload/types";
 
 // This is the type used for incoming global configs.
 // Only the bare minimum properties are marked as required.
 ```
 
 ```ts
-import { SanitizedGlobalConfig } from 'payload/types';
+import { SanitizedGlobalConfig } from "payload/types";
 
 // This is the type used after an incoming global config is fully sanitized.
 // Generally, this is only used internally by Payload.

docs/configuration/i18n.mdx

@@ -12,7 +12,9 @@ While Payload's built-in features come translated, you may want to also translat
 
 Here is an example of a simple collection supporting both English and Spanish editors:
 ```ts
-const Articles: CollectionConfig = {
+import { CollectionConfig } from 'payload/types';
+
+export const Articles: CollectionConfig = {
   slug: 'articles',
   labels: {
     singular: {

docs/configuration/localization.mdx

@@ -72,6 +72,15 @@ All field types with a `name` property support the `localized` property—even t
   Enabling localization for field types that support nested fields will automatically create localized "sets" of all fields contained within the field. For example, if you have a page layout using a blocks field type, you have the choice of either localizing the full layout, by enabling localization on the top-level blocks field, or only certain fields within the layout.
 </Banner>
 
+<Banner type="warning">
+  <strong>Important:</strong>
+  <br />
+  When converting an existing field to or from `localized: true` the data
+  structure in the document will change for this field and so existing data for
+  this field will be lost. Before changing the localization setting on fields
+  with existing data, you may need to consider a field migration strategy.
+</Banner>
+
 ### Retrieving localized docs
 
 When retrieving documents, you can specify which locale you'd like to receive as well as which fallback locale should be used.

docs/configuration/overview.mdx

@@ -6,82 +6,86 @@ desc: The Payload config is central to everything that Payload does, from adding
 keywords: overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-Payload is a *config-based*, code-first CMS and application framework. The Payload config is central to everything that Payload does. It scaffolds the data that Payload stores as well as maintains custom React components, hook logic, custom validations, and much more. The config itself and all of its dependencies are run through Babel, so you can take full advantage of newer JavaScript features and even directly import React components containing JSX.
+Payload is a _config-based_, code-first CMS and application framework. The Payload config is central to everything that Payload does. It scaffolds the data that Payload stores as well as maintains custom React components, hook logic, custom validations, and much more.
 
-**Also, because the Payload source code is fully written in TypeScript, its configs are strongly typed—meaning that even if you aren't using TypeScript to build your project, your IDE (such as VSCode) may still provide helpful information like type-ahead suggestions while you write your config.**
+**Also, because the Payload source code is fully written in TypeScript, its configs are strongly typed—meaning that even if you aren't using TypeScript, your IDE (such as VSCode) may still provide helpful information like type-ahead suggestions while you write your config.**
 
 <Banner type="warning">
-	<strong>Important:</strong><br />This file is included in the Payload admin bundle, so make sure you do not embed any sensitive information.
+  <strong>Important:</strong>
+  <br />
+  This file is included in the Payload admin bundle, so make sure you do not
+  embed any sensitive information.
 </Banner>
 
 ## Options
 
-| Option               | Description  |
-| -------------------- | -------------|
-| `serverURL`          | A string used to define the absolute URL of your app including the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port |
-| `collections`        | An array of all Collections that Payload will manage. To read more about how to define your collection configs, [click here](/docs/configuration/collections). |
-| `cors`               | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain. |
-| `globals`            | An array of all Globals that Payload will manage. For more on Globals and their configs, [click here](/docs/configuration/globals). |
-| `admin`              | Base Payload admin configuration. Specify custom components, control metadata, set the Admin user collection, and [more](/docs/admin/overview#admin-options). |
-| `localization`       | Opt-in and control how Payload handles the translation of your content into multiple locales. [More](/docs/configuration/localization) |
-| `graphQL`            | Manage GraphQL-specific functionality here. Define your own queries and mutations, manage query complexity limits, and [more](/docs/graphql/overview#graphql-options). |
-| `cookiePrefix`       | A string that will be prefixed to all cookies that Payload sets. |
-| `csrf`               | A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. [More](/docs/authentication/overview#csrf-protection) |
-| `defaultDepth`       | If a user does not specify `depth` while requesting a resource, this depth will be used. [More](/docs/getting-started/concepts#depth) |
-| `maxDepth`           | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`. |
-| `indexSortableFields`| Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar. |
-| `upload`             | Base Payload upload configuration. [More](/docs/upload/overview#payload-wide-upload-options). |
-| `routes`             | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`. |
-| `email`              | Base email settings to allow Payload to generate email such as Forgot Password requests and other requirements. [More](/docs/email/overview#configuration) |
-| `express`            | Express-specific middleware options such as compression and JSON parsing. [More](/docs/configuration/express) |
-| `debug`              | Enable to expose more detailed error information. |
-| `telemetry`          | Disable Payload telemetry by passing `false`. [More](/docs/configuration/overview#telemetry) |
-| `rateLimit`          | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks and [more](/docs/production/preventing-abuse#rate-limiting-requests). |
-| `hooks`              | Tap into Payload-wide hooks. [More](/docs/hooks/overview) |
-| `plugins`            | An array of Payload plugins. [More](/docs/plugins/overview) |
-| `endpoints`          | An array of custom API endpoints added to the Payload router. [More](/docs/rest-api/overview#custom-endpoints) |
+| Option                | Description                                                                                                                                                                   |
+| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `serverURL`           | A string used to define the absolute URL of your app including the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port |
+| `collections`         | An array of all Collections that Payload will manage. To read more about how to define your collection configs, [click here](/docs/configuration/collections).                |
+| `cors`                | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain.                                       |
+| `globals`             | An array of all Globals that Payload will manage. For more on Globals and their configs, [click here](/docs/configuration/globals).                                           |
+| `admin`               | Base Payload admin configuration. Specify custom components, control metadata, set the Admin user collection, and [more](/docs/admin/overview#admin-options).                 |
+| `localization`        | Opt-in and control how Payload handles the translation of your content into multiple locales. [More](/docs/configuration/localization)                                        |
+| `graphQL`             | Manage GraphQL-specific functionality here. Define your own queries and mutations, manage query complexity limits, and [more](/docs/graphql/overview#graphql-options).        |
+| `cookiePrefix`        | A string that will be prefixed to all cookies that Payload sets.                                                                                                              |
+| `csrf`                | A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. [More](/docs/authentication/overview#csrf-protection)                    |
+| `defaultDepth`        | If a user does not specify `depth` while requesting a resource, this depth will be used. [More](/docs/getting-started/concepts#depth)                                         |
+| `maxDepth`            | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`.                                           |
+| `indexSortableFields` | Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar.                    |
+| `upload`              | Base Payload upload configuration. [More](/docs/upload/overview#payload-wide-upload-options).                                                                                 |
+| `routes`              | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`.                                                       |
+| `email`               | Base email settings to allow Payload to generate email such as Forgot Password requests and other requirements. [More](/docs/email/overview#configuration)                    |
+| `express`             | Express-specific middleware options such as compression and JSON parsing. [More](/docs/configuration/express)                                                                 |
+| `debug`               | Enable to expose more detailed error information.                                                                                                                             |
+| `telemetry`           | Disable Payload telemetry by passing `false`. [More](/docs/configuration/overview#telemetry)                                                                                  |
+| `rateLimit`           | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks and [more](/docs/production/preventing-abuse#rate-limiting-requests).                  |
+| `hooks`               | Tap into Payload-wide hooks. [More](/docs/hooks/overview)                                                                                                                     |
+| `plugins`             | An array of Payload plugins. [More](/docs/plugins/overview)                                                                                                                   |
+| `endpoints`           | An array of custom API endpoints added to the Payload router. [More](/docs/rest-api/overview#custom-endpoints)                                                                |
+| `custom`              | Extension point for adding custom data (e.g. for plugins)                                                                                                                     |
 
 #### Simple example
 
 ```ts
-import { buildConfig } from 'payload/config';
+import { buildConfig } from "payload/config";
 
 export default buildConfig({
-	collections: [
-		{
-			slug: 'pages',
-			fields: [
-				{
-					name: 'title',
-					type: 'text',
-					required: true,
-				},
-				{
-					name: 'content',
-					type: 'richText',
-					required: true,
-				}
-			]
-		}
-	],
-	globals: [
-		{
-			slug: 'header',
-			fields: [
-				{
-					name: 'nav',
-					type: 'array',
-					fields: [
-						{
-							name: 'page',
-							type: 'relationship',
-							relationTo: 'pages',
-						},
-					]
-				}
-			]
-		}
-	]
+  collections: [
+    {
+      slug: "pages",
+      fields: [
+        {
+          name: "title",
+          type: "text",
+          required: true,
+        },
+        {
+          name: "content",
+          type: "richText",
+          required: true,
+        },
+      ],
+    },
+  ],
+  globals: [
+    {
+      slug: "header",
+      fields: [
+        {
+          name: "nav",
+          type: "array",
+          fields: [
+            {
+              name: "page",
+              type: "relationship",
+              relationTo: "pages",
+            },
+          ],
+        },
+      ],
+    },
+  ],
 });
 ```
 
@@ -94,12 +98,15 @@ You can see a full [example config](https://github.com/payloadcms/public-demo/bl
 We suggest using the `dotenv` package to handle environment variables alongside of Payload. All that's necessary to do is to require the package as high up in your application as possible (for example, at the top of your `server.js` file), and ensure that it can find an `.env` file that you create.
 
 **Add this line to the top of your server:**
+
 ```
 require('dotenv').config()
 // ...
 // the rest of your `server.js` file goes here
 ```
 
+Note that if you rely on any environment variables in your config itself, you should also call `dotenv()` at the top of your config itself as well. There's no harm in calling it in both your server and your config itself!
+
 **Here is an example project structure w/ `dotenv` and an `.env` file:**
 
 ```
@@ -111,8 +118,13 @@ project-name
 ```
 
 <Banner type="warning">
-	<strong>Important:</strong><br />
-	If you use an environment variable to configure any properties that are required for the Admin panel to function (ex. serverURL or any routes), you need to make sure that your Admin panel code can access it. <a href="/docs/admin/webpack#admin-environment-vars">Click here</a> for more info.
+  <strong>Important:</strong>
+  <br />
+  If you use an environment variable to configure any properties that are
+  required for the Admin panel to function (ex. serverURL or any routes), you
+  need to make sure that your Admin panel code can access it.{" "}
+  <a href="/docs/admin/webpack#admin-environment-vars">Click here</a> for more
+  info.
 </Banner>
 
 ### Customizing & overriding the config location
@@ -133,53 +145,21 @@ But, you can specify where your Payload config is located as well as what it's n
 
 ### Developing within the Config
 
-The Payload config itself, as well as all files that it requires or imports, are run through Babel. TypeScript and all common ES6 features are fully supported. To see the Babel config that is used to parse Payload configs, check out the Payload source code [here](https://github.com/payloadcms/payload/blob/master/src/babel.config.js).
-
 Payload comes with `isomorphic-fetch` installed which means that even in Node, you can use the `fetch` API just as you would within the browser. No need to import `axios` or similar, unless you want to!
 
-#### Payload Config and Babel
-
-The entire Payload config is transpiled automatically by Payload via `babel`.
-
-If for any reason you need to re-use the built-in Payload `babel.config.js`, you can do so by importing it as follows:
-
-```
-import { config } from 'payload/babel';
-```
-
-<Banner type="warning">
-  <strong>Note:</strong><br/>
-  Because the Payload config is transpiled internally, if you want to import it to share or reuse any of its properties within your own Node server's code, you need to make sure that <em>you manually transpile it</em> using <strong>babel-register</strong> or similar. For example, if you try to import your config directly into your server, your Node process will likely crash because the Payload config supports React components, TypeScript, and new ES6+ features.
-</Banner>
-
-However, you can share code, like for example your config's `serverURL` property by "hoisting" your shared properties above your config and writing any "shared" code in a module that is compatible with your Node environment.
-
-For example, to share your `serverURL`, you could create a file like the following:
-
-`serverURL.js`:
-
-```js
-const serverURL = 'http://localhost:3000';
-
-module.exports = serverURL;
-```
-
-Then, you could import this file into both your Payload config and your server, in an effort to avoid importing your full Payload config directly into your server.
-
-
 ### TypeScript
 
 You can import config types as follows:
 
 ```ts
-import { Config } from 'payload/config';
+import { Config } from "payload/config";
 
 // This is the type used for an incoming Payload config.
 // Only the bare minimum properties are marked as required.
 ```
 
 ```ts
-import { SanitizedConfig } from 'payload/config';
+import { SanitizedConfig } from "payload/config";
 
 // This is the type used after an incoming Payload config is fully sanitized.
 // Generally, this is only used internally by Payload.

docs/email/overview.mdx

@@ -143,7 +143,7 @@ payload.init({
 [06:37:21] INFO  (payload): Starting Payload...
 [06:37:22] INFO  (payload): Payload Demo Initialized
 [06:37:22] INFO  (payload): listening on 3000...
-[06:37:22] INFO  (payload): Connected to Mongo server successfully!
+[06:37:22] INFO  (payload): Connected to MongoDB server successfully!
 [06:37:23] INFO  (payload): E-mail configured with mock configuration
 [06:37:23] INFO  (payload): Log into mock email provider at https://ethereal.email
 [06:37:23] INFO  (payload): Mock email account username: hhav5jw7doo4euev@ethereal.email

docs/fields/array.mdx

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

docs/fields/blocks.mdx

@@ -6,8 +6,11 @@ desc: The Blocks field type is a great layout build and can be used to construct
 keywords: blocks, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-<Banner >
-  The Blocks field type is <strong>incredibly powerful</strong> and can be used as a <em>layout builder</em> as well as to define any other flexible content model you can think of. It stores an array of objects, where each object must match the shape of one of your provided block configs.
+<Banner>
+  The Blocks field type is <strong>incredibly powerful</strong> and can be used
+  as a <em>layout builder</em> as well as to define any other flexible content
+  model you can think of. It stores an array of objects, where each object must
+  match the shape of one of your provided block configs.
 </Banner>
 
 **Example uses:**
@@ -17,15 +20,14 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
 - Virtual event agenda "timeslots" where a timeslot could either be a `Break`, a `Presentation`, or a `BreakoutSession`.
 
 ![Blocks field in Payload admin panel](https://payloadcms.com/images/docs/fields/blocks.jpg)
-*Admin panel screenshot of a Blocks field type with Call to Action and Number block examples*
-
+_Admin panel screenshot of a Blocks field type with Call to Action and Number block examples_
 
 ### Field config
 
 | Option                  | Description                                                                                                                                                                                                                                                                        |
 |-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** *            | To be used as the property name when stored and retrieved from the database.                                                                                                                                                                                                       |
-| **`label`**             | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                                                                                                              |
+| **`name`** *            | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
+| **`label`**             | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
 | **`blocks`** *          | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field.                                                                                                                                                                                    |
 | **`validate`**          | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
 | **`saveToJWT`**         | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                                                                                      |
@@ -33,38 +35,46 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
 | **`access`**            | Provide field-level access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                                                                                            |
 | **`hidden`**            | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin panel.                                                                                                                          |
 | **`defaultValue`**      | Provide an array of block data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                             |
-| **`localized`**         | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. || **`required`**       | Require this field to have a value. |
+| **`localized`**         | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. |
 | **`unique`**            | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                                                                                                       |
 | **`labels`**            | Customize the block row labels appearing in the Admin dashboard.                                                                                                                                                                                                                   |
 | **`admin`**             | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                                                                                          |
+| **`custom`**            | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
 
-*\* An asterisk denotes that a property is required.*
+_\* An asterisk denotes that a property is required._
 
 ### Admin Config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
 
-| Option                 | Description                     |
-| ---------------------- | ------------------------------- |
-| **`initCollapsed`**    | Set the initial collapsed state |
+| Option              | Description                     |
+| ------------------- | ------------------------------- |
+| **`initCollapsed`** | Set the initial collapsed state |
 
 ### Block configs
 
 Blocks are defined as separate configs of their own.
 
 <Banner type="success">
-  <strong>Tip:</strong><br />
-  Best practice is to define each block config in its own file, and then import them into your Blocks field as necessary. This way each block config can be easily shared between fields. For instance, using the "layout builder" example, you might want to feature a few of the same blocks in a Post collection as well as a Page collection. Abstracting into their own files trivializes their reusability.
+  <strong>Tip:</strong>
+  <br />
+  Best practice is to define each block config in its own file, and then import
+  them into your Blocks field as necessary. This way each block config can be
+  easily shared between fields. For instance, using the "layout builder"
+  example, you might want to feature a few of the same blocks in a Post
+  collection as well as a Page collection. Abstracting into their own files
+  trivializes their reusability.
 </Banner>
 
-| Option                     | Description                                                                                             |
-|----------------------------|---------------------------------------------------------------------------------------------------------|
-| **`slug`** *               | Identifier for this block type. Will be saved on each block as the `blockType` property.                |
-| **`fields`** *             | Array of fields to be stored in this block.                                                             |
-| **`labels`**               | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined. |
-| **`imageURL`**             | Provide a custom image thumbnail to help editors identify this block in the Admin UI.                   |
-| **`imageAltText`**         | Customize this block's image thumbnail alt text.                                                        |
-| **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined                        |
+| Option                     | Description                                                                                                                                                                         |
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`slug`** \*              | Identifier for this block type. Will be saved on each block as the `blockType` property.                                                                                            |
+| **`fields`** \*            | Array of fields to be stored in this block.                                                                                                                                         |
+| **`labels`**               | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined.                                                                             |
+| **`imageURL`**             | Provide a custom image thumbnail to help editors identify this block in the Admin UI.                                                                                               |
+| **`imageAltText`**         | Customize this block's image thumbnail alt text.                                                                                                                                    |
+| **`interfaceName`**        | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
+| **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined. NOTE: this is set for deprecation, prefer `interfaceName`.                                        |
 
 #### Auto-generated data per block
 
@@ -81,6 +91,7 @@ The Admin panel provides each block with a `blockName` field which optionally al
 ### Example
 
 `collections/ExampleCollection.js`
+
 ```ts
 import { Block, CollectionConfig } from 'payload/types';
 
@@ -88,7 +99,9 @@ const QuoteBlock: Block = {
   slug: 'Quote', // required
   imageURL: 'https://google.com/path/to/image.jpg',
   imageAltText: 'A nice thumbnail image to show what this block looks like',
-  fields: [ // required
+  interfaceName: 'QuoteBlock', // optional
+  fields: [
+    // required
     {
       name: 'quoteHeader',
       type: 'text',
@@ -98,10 +111,10 @@ const QuoteBlock: Block = {
       name: 'quoteText',
       type: 'text',
     },
-  ]
+  ],
 };
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {
@@ -109,13 +122,13 @@ const ExampleCollection: CollectionConfig = {
       type: 'blocks', // required
       minRows: 1,
       maxRows: 20,
-      blocks: [ // required
-       QuoteBlock
-      ]
-    }
-  ]
-}
-
+      blocks: [
+        // required
+        QuoteBlock,
+      ],
+    },
+  ],
+};
 ```
 
 ### TypeScript
@@ -124,5 +137,4 @@ As you build your own Block configs, you might want to store them in separate fi
 
 ```ts
 import type { Block } from 'payload/types';
-
 ```

docs/fields/checkbox.mdx

@@ -14,7 +14,7 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database. |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
@@ -26,6 +26,7 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -35,7 +36,7 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/code.mdx

@@ -11,13 +11,13 @@ keywords: code, fields, config, configuration, documentation, Content Management
   The Code field type saves a string in the database, but provides the Admin panel with a code editor styled interface.
 </Banner>
 
-This field uses `prismjs` for syntax highlighting and `react-simple-code-editor` for the editor itself.
+This field uses the `monaco-react` editor syntax highlighting.
 
 ### Config
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
@@ -32,26 +32,18 @@ This field uses `prismjs` for syntax highlighting and `react-simple-code-editor`
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
-*\* An asterisk denotes that a property is required.*
+_\* An asterisk denotes that a property is required._
 
-### Admin config
+### Admin Config
 
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Code field type also allows for the customization of a `language` property.
+In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
 
-The following `prismjs` plugins are imported, enabling the `language` property to accept the following values:
-
-| Plugin                       | Language |
-| ---------------------------- | ----------- |
-| **`prism-css`**              | `css` |
-| **`prism-clike`**            | `clike` |
-| **`prism-markup`**           | `markup`, `html`, `xml`, `svg`, `mathml`, `ssml`, `atom`, `rss` |
-| **`prism-javascript`**       | `javascript`, `js` |
-| **`prism-json`**             | `json` |
-| **`prism-jsx`**              | `jsx` |
-| **`prism-typescript`**       | `typescript`, `ts` |
-| **`prism-tsx`**              | `tsx` |
-| **`prism-yaml`**             | `yaml`, `yml` |
+| Option                 | Description                                                                                                                                                                         |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`language`**         | This property can be set to any language listed [here](https://github.com/microsoft/monaco-editor/tree/main/src/basic-languages).                                           |
+| **`editorOptions`**    | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IDiffEditorConstructionOptions.html).  |
 
 ### Example
 
@@ -59,7 +51,7 @@ The following `prismjs` plugins are imported, enabling the `language` property t
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {
@@ -67,7 +59,7 @@ const ExampleCollection: CollectionConfig = {
       type: 'code', // required
       required: true,
       admin: {
-        language: 'js'
+        language: 'javascript'
       }
     }
   ]

docs/fields/collapsible.mdx

@@ -17,6 +17,7 @@ keywords: row, fields, config, configuration, documentation, Content Management
 | **`label`** *  | A label to render within the header of the collapsible component. This can be a string, function or react component. Function/components receive `({ data, path })` as args. |
 | **`fields`** * | Array of field types to nest within this Collapsible.                     |
 | **`admin`**    | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**   | Extension point for adding custom data (e.g. for plugins)                 |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -34,7 +35,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/date.mdx

@@ -17,8 +17,8 @@ This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepic
 
 | Option             | Description                                                                                                                                                                                         |
 | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database.                                                                                                                        |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                                    |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
 | **`index`**        | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
 | **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
 | **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
@@ -28,7 +28,8 @@ This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepic
 | **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
 | **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
 | **`required`**     | Require this field to have a value.                                                                                                                                                                 |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                  |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
@@ -36,45 +37,72 @@ _\* An asterisk denotes that a property is required._
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), you can customize the following fields that will adjust how the component displays in the admin panel via the `date` property.
 
-| Option                 | Description                                                                                                                                         |
-| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`pickerAppearance`** | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. Defaults to `dayAndTime`.                                           |
-| **`displayFormat`**    | Determines how the date is presented. dayAndTime default to `MMM d, yyy h:mm a` timeOnly defaults to `h:mm a` dayOnly defaults to `MMM d, yyy` and monthOnly defaults to `MM/yyyy`. |
-| **`placeholder`**      | Placeholder text for the field.                                                                                                                     |
-| **`monthsToShow`**     | Number of months to display max is 2. Defaults to 1.                                                                                                |
-| **`minDate`**          | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md).                               |
-| **`maxDate`**          | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md).                               |
-| **`minTime`**          | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md).                               |
-| **`maxTime`**          | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md).                               |
-| **`timeIntervals`**    | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). Defaults to 30 minutes.       |
-| **`timeFormat`**       | Passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). Defaults to `'h:mm aa'`.      |
+| Property                       | Description                                                                                 |
+| ------------------------------ | ------------------------------------------------------------------------------------------- |
+| **`placeholder`**              | Placeholder text for the field.                                                             |
+| **`date`**                     | Pass options to customize date field appearance.                                            |
+| **`date.displayFormat`**       | Format date to be shown in field **cell**.                                                  |
+| **`date.pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. |
+| **`date.monthsToShow`** \*     | Number of months to display max is 2. Defaults to 1.                                        |
+| **`date.minDate`** \*          | Min date value to allow.                                                                    |
+| **`date.maxDate`** \*          | Max date value to allow.                                                                    |
+| **`date.minTime`** \*          | Min time value to allow.                                                                    |
+| **`date.maxTime`** \*          | Max date value to allow.                                                                    |
+| **`date.timeIntervals`** \*    | Time intervals to display. Defaults to 30 minutes.                                          |
+| **`date.timeFormat`** \*       | Determines time format. Defaults to `'h:mm aa'`.                                            |
 
-_\* An asterisk denotes that a property is required._
+_\* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._
 
-Common use cases for customizing the `date` property are to restrict your field to only show time or day input—but lots more can be done.
+#### Display Format and Picker Appearance
+
+These properties only affect how the date is displayed in the UI. The full date is always stored in the format `YYYY-MM-DDTHH:mm:ss.SSSZ` (e.g. `1999-01-01T8:00:00.000+05:00`).
+
+`displayFormat` determines how the date is presented in the field **cell**, you can pass any valid (unicode date format)[https://date-fns.org/v2.29.3/docs/format].
+
+`pickerAppearance` sets the appearance of the **react datepicker**, the options available are `dayAndTime`, `dayOnly`, `timeOnly`, and `monthOnly`. By default, the datepicker will display `dayOnly`.
+
+When only `pickerAppearance` is set, an equivalent format will be rendered in the date field cell. To overwrite this format, set `displayFormat`.
 
 ### Example
 
 `collections/ExampleCollection.ts`
 
 ```ts
-import { CollectionConfig } from 'payload/types';
+import { CollectionConfig } from "payload/types";
 
-const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
+export const ExampleCollection: CollectionConfig = {
+  slug: "example-collection",
   fields: [
     {
-      name: 'time', // required
-      type: 'date', // required
-      label: 'Event Start Time',
-      defaultValue: '1988-11-05T8:00:00.000+05:00',
+      name: "dateOnly",
+      type: "date",
       admin: {
         date: {
-          // All config options above should be placed here
-          pickerAppearance: 'timeOnly',
-        }
-      }
-    }
-  ]
+          pickerAppearance: "dayOnly",
+          displayFormat: "d MMM yyy",
+        },
+      },
+    },
+    {
+      name: "timeOnly",
+      type: "date",
+      admin: {
+        date: {
+          pickerAppearance: "timeOnly",
+          displayFormat: "h:mm:ss a",
+        },
+      },
+    },
+    {
+      name: "monthOnly",
+      type: "date",
+      admin: {
+        date: {
+          pickerAppearance: "monthOnly",
+          displayFormat: "MMMM yyyy",
+        },
+      },
+    },
+  ],
 };
 ```

docs/fields/email.mdx

@@ -14,7 +14,7 @@ keywords: email, fields, config, configuration, documentation, Content Managemen
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
@@ -27,6 +27,7 @@ keywords: email, fields, config, configuration, documentation, Content Managemen
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -48,7 +49,7 @@ Set this property to a string that will be used for browser autocomplete.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/group.mdx

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

docs/fields/json.mdx

@@ -0,0 +1,61 @@
+---
+title: JSON Field
+label: JSON
+order: 50
+desc: The JSON field type will store any string in the Database. Learn how to use JSON fields, see examples and options.
+
+keywords: json, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
+---
+
+<Banner >
+  The JSON field type saves actual JSON in the database, which differs from the Code field that saves the value as a string in the database.
+</Banner>
+
+This field uses the `monaco-react` editor syntax highlighting.
+
+### Config
+
+| Option           | Description |
+| ---------------- | ----------- |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
+| **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
+| **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
+| **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
+| **`saveToJWT`**      | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
+| **`hooks`**          | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) |
+| **`access`**         | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |
+| **`hidden`**         | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. |
+| **`defaultValue`**   | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) |
+| **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
+| **`required`**       | Require this field to have a value. |
+| **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
+
+_\* An asterisk denotes that a property is required._
+
+### Admin Config
+
+In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
+
+| Option                 | Description                                                                                                                                                                         |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`editorOptions`**    | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IDiffEditorConstructionOptions.html).  |
+
+### Example
+
+`collections/ExampleCollection.ts
+```ts
+import { CollectionConfig } from 'payload/types';
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'customerJSON', // required
+      type: 'json', // required
+      required: true,
+    }
+  ]
+};
+```

docs/fields/number.mdx

@@ -14,7 +14,7 @@ keywords: number, fields, config, configuration, documentation, Content Manageme
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`min`**            | Minimum value accepted. Used in the default `validation` function. |
 | **`max`**            | Maximum value accepted. Used in the default `validation` function. |
@@ -29,6 +29,7 @@ keywords: number, fields, config, configuration, documentation, Content Manageme
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -54,7 +55,7 @@ Set this property to a string that will be used for browser autocomplete.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/overview.mdx

@@ -19,7 +19,7 @@ The required `type` property on a field determines what values it can accept, ho
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Page: CollectionConfig = {
+export const Page: CollectionConfig = {
 	slug: 'pages',
 	fields: [
 		{
@@ -64,6 +64,10 @@ One of the most powerful parts about Payload is its ability for you to define fi
 
 In addition to being able to define access control on a document-level, you can define extremely granular permissions on a field by field level. For more information about field-level access control, [click here](/docs/access-control/overview#fields).
 
+### Field names
+
+Some fields use their `name` property as a unique identifier to store and retrieve from the database. `__v`, `salt`, and `hash` are all reserved field names which are sanitized from Payload's config and cannot be used.
+
 ### Validation
 
 Field validation is enforced automatically based on the field type and other properties such as `required` or `min` and `max` value constraints on certain field types. This default behavior can be replaced by providing your own validate function for any field. It will be used on both the frontend and the backend, so it should not rely on any Node-specific packages. The validation function can be either synchronous or asynchronous and expects to return either `true` or a string error message to display in both API responses and within the Admin panel.
@@ -86,7 +90,7 @@ Example:
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Orders: CollectionConfig = {
+export const Orders: CollectionConfig = {
   slug: 'orders',
   fields: [
     {
@@ -151,18 +155,19 @@ Example:
 
 In addition to each field's base configuration, you can define specific traits and properties for fields that only have effect on how they are rendered in the Admin panel. The following properties are available for all fields within the `admin` property:
 
-| Option        | Description  |
-| ------------- | -------------|
-| `condition`   | You can programmatically show / hide fields based on what other fields are doing. [Click here](#conditional-logic) for more info. |
-| `components`  | All field components can be completely and easily swapped out for custom components that you define. [Click here](#custom-components) for more info. |
-| `description` | Helper text to display with the field to provide more information for the editor user. [Click here](#description) for more info. |
-| `position`    | Specify if the field should be rendered in the sidebar by defining `position: 'sidebar'`. |
-| `width`       | Restrict the width of a field. you can pass any string-based value here, be it pixels, percentages, etc. This property is especially useful when fields are nested within a `Row` type where they can be organized horizontally. |
-| `style`       | Attach raw CSS style properties to the root DOM element of a field. |
-| `className`   | Attach a CSS class name to the root DOM element of a field. |
-| `readOnly`    | Setting a field to `readOnly` has no effect on the API whatsoever but disables the admin component's editability to prevent editors from modifying the field's value. |
-| `disabled`    | If a field is `disabled`, it is completely omitted from the Admin panel. |
-| `hidden`      | Setting a field's `hidden` property on its `admin` config will transform it into a `hidden` input type. Its value will still submit with the Admin panel's requests, but the field itself will not be visible to editors. |
+| Option            | Description                                                                                                                                                                                                                     |
+|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `condition`       | You can programmatically show / hide fields based on what other fields are doing. [Click here](#conditional-logic) for more info.                                                                                               |
+| `components`      | All field components can be completely and easily swapped out for custom components that you define. [Click here](#custom-components) for more info.                                                                            |
+| `description`     | Helper text to display with the field to provide more information for the editor user. [Click here](#description) for more info.                                                                                                |
+| `position`        | Specify if the field should be rendered in the sidebar by defining `position: 'sidebar'`.                                                                                                                                       |
+| `width`           | Restrict the width of a field. you can pass any string-based value here, be it pixels, percentages, etc. This property is especially useful when fields are nested within a `Row` type where they can be organized horizontally. |
+| `style`           | Attach raw CSS style properties to the root DOM element of a field.                                                                                                                                                             |
+| `className`       | Attach a CSS class name to the root DOM element of a field.                                                                                                                                                                     |
+| `readOnly`        | Setting a field to `readOnly` has no effect on the API whatsoever but disables the admin component's editability to prevent editors from modifying the field's value.                                                           |
+| `disabled`        | If a field is `disabled`, it is completely omitted from the Admin panel.                                                                                                                                                        |
+| `disableBulkEdit` | Set `disableBulkEdit` to `true` to prevent fields from appearing in the select options when making edits for multiple documents.                                                                                                |
+| `hidden`          | Setting a field's `hidden` property on its `admin` config will transform it into a `hidden` input type. Its value will still submit with the Admin panel's requests, but the field itself will not be visible to editors.       |
 
 ### Custom components
 
@@ -170,10 +175,11 @@ All Payload fields support the ability to swap in your own React components with
 
 ### Conditional logic
 
-You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes two arguments:
+You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes three arguments:
 
 - `data` - the entire document's data that is currently being edited
 - `siblingData` - only the fields that are direct siblings to the field with the condition
+- `{ user }` - the final argument is an object containing the currently authenticated user
 
 The `condition` function should return a boolean that will control if the field should be displayed or not.
 
@@ -192,7 +198,7 @@ The `condition` function should return a boolean that will control if the field
       type: 'text',
       admin: {
         // highlight-start
-        condition: (data, siblingData) => {
+        condition: (data, siblingData, { user }) => {
           if (data.enableGreeting) {
             return true;
           } else {

docs/fields/point.mdx

@@ -17,7 +17,7 @@ The data structure in the database matches the GeoJSON structure to represent po
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Used as a field label in the Admin panel and to name the generated GraphQL type. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. To support location queries, point index defaults to `2dsphere`, to disable the index set to `false`. |
@@ -30,6 +30,7 @@ The data structure in the database matches the GeoJSON structure to represent po
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -39,7 +40,7 @@ The data structure in the database matches the GeoJSON structure to represent po
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/radio.mdx

@@ -1,5 +1,5 @@
 ---
-title: Radio Field
+title: Radio Group Field
 label: Radio Group
 order: 120
 desc: The Radio field type allows for the selection of one value from a predefined set of possible values. Learn how to use Radio fields, see examples and options.
@@ -7,14 +7,14 @@ keywords: radio, fields, config, configuration, documentation, Content Managemen
 ---
 
 <Banner >
-  The Radio field type allows for the selection of one value from a predefined set of possible values and presents a radio group-style set of inputs to the Admin panel.
+  The Radio Group field type allows for the selection of one value from a predefined set of possible values and presents a radio group-style set of inputs to the Admin panel.
 </Banner>
 
 ### Config
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`options`** *      | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing an `label` string and a `value` string. |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
@@ -27,6 +27,7 @@ keywords: radio, fields, config, configuration, documentation, Content Managemen
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -37,7 +38,7 @@ keywords: radio, fields, config, configuration, documentation, Content Managemen
 
 ### Admin config
 
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Radio field type allows for the specification of the following `admin` properties:
+In addition to the default [field admin config](/docs/fields/overview#admin-config), the Radio Group field type allows for the specification of the following `admin` properties:
 
 **`layout`**
 
@@ -49,7 +50,7 @@ The `layout` property allows for the radio group to be styled as a horizonally o
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {
@@ -72,5 +73,4 @@ const ExampleCollection: CollectionConfig = {
     }
   ]
 }
-
 ```

docs/fields/relationship.mdx

@@ -6,8 +6,9 @@ desc: The Relationship field provides the ability to relate documents together.
 keywords: relationship, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-<Banner >
-  The Relationship field is one of the most powerful fields Payload features. It provides for the ability to easily relate documents together.
+<Banner>
+  The Relationship field is one of the most powerful fields Payload features. It
+  provides for the ability to easily relate documents together.
 </Banner>
 
 **Example uses:**
@@ -18,31 +19,36 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma
 
 ### Config
 
-| Option           | Description |
-| ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
-| **`relationTo`** *   | Provide one or many collection `slug`s to be able to assign relationships to. |
-| **`filterOptions`**  | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options). |
-| **`hasMany`**        | Boolean when, if set to `true`, allows this field to have many relations instead of only one. |
-| **`maxDepth`**       | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth) |
-| **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
-| **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
-| **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
-| **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**      | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
-| **`hooks`**          | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) |
-| **`access`**         | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |
-| **`hidden`**         | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. |
-| **`defaultValue`**   | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) |
-| **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
-| **`required`**       | Require this field to have a value. |
-| **`admin`**          | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
+| Option              | Description                                                                                                                                                                                         |
+| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`relationTo`** \* | Provide one or many collection `slug`s to be able to assign relationships to.                                                                                                                       |
+| **`filterOptions`** | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options).                                                                                     |
+| **`hasMany`**       | Boolean when, if set to `true`, allows this field to have many relations instead of only one.                                                                                                       |
+| **`min`**           | A number for the fewest allowed items during validation when a value is present. Used with `hasMany`.                                                                                               |
+| **`max`**           | A number for the most allowed items during validation when a value is present. Used with `hasMany`.                                                                                                 |
+| **`maxDepth`**      | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth)                                                                      |
+| **`label`**         | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`unique`**        | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
+| **`validate`**      | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
+| **`index`**         | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**         | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**        | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`**  | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**      | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**         | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                                            |
+| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
-*\* An asterisk denotes that a property is required.*
+_\* An asterisk denotes that a property is required._
 
 <Banner type="success">
-  <strong>Tip:</strong><br/>
-  The <a href="/docs/getting-started/concepts#depth">Depth</a> parameter can be used to automatically populate related documents that are returned by the API.
+  <strong>Tip:</strong>
+  <br />
+  The <a href="/docs/getting-started/concepts#depth">Depth</a> parameter can be
+  used to automatically populate related documents that are returned by the API.
 </Banner>
 
 ### Admin config
@@ -51,7 +57,11 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 
 **`isSortable`**
 
-Set to `true` if you'd like this field to be sortable within the Admin UI using drag and drop. (Only works when `hasMany` is set to `true`)
+Set to `true` if you'd like this field to be sortable within the Admin UI using drag and drop (only works when `hasMany` is set to `true`).
+
+**`allowCreate`**
+
+Set to `false` if you'd like to disable the ability to create new documents from within the relationship field (hides the "Add new" button in the admin UI).
 
 ### Filtering relationship options
 
@@ -59,43 +69,55 @@ Options can be dynamically limited by supplying a [query constraint](/docs/queri
 
 The `filterOptions` property can either be a `Where` query directly, or a function that returns one. When using a function, it will be called with an argument object with the following properties:
 
-| Property      | Description  |
-| ------------- | -------------|
-| `relationTo`       | The `relationTo` to filter against (as defined on the field) |
-| `data`             | An object of the full collection or global document currently being edited |
-| `siblingData`      | An object of the document data limited to fields within the same parent to the field |
-| `id`               | The value of the collection `id`, will be `undefined` on create request |
-| `user`             | The currently authenticated user object |
+| Property      | Description                                                                          |
+| ------------- | ------------------------------------------------------------------------------------ |
+| `relationTo`  | The `relationTo` to filter against (as defined on the field)                         |
+| `data`        | An object of the full collection or global document currently being edited           |
+| `siblingData` | An object of the document data limited to fields within the same parent to the field |
+| `id`          | The value of the collection `id`, will be `undefined` on create request              |
+| `user`        | The currently authenticated user object                                              |
 
-**Example:**
+### Example
 
 ```ts
-const relationshipField = {
-  name: 'purchase',
-  type: 'relationship',
-  relationTo: ['products', 'services'],
-  filterOptions: ({ relationTo, siblingData }) => {
-    // returns a Where query dynamically by the type of relationship
-    if (relationTo === 'products') {
-      return {
-        'stock': { greater_than: siblingData.quantity }
-      }
-    }
+import { CollectionConfig } from "payload/types";
 
-    if (relationTo === 'services') {
-      return {
-        'isAvailable': { equals: true }
-      }
-    }
-  },
+export const ExampleCollection: CollectionConfig = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "purchase",
+      type: "relationship",
+      relationTo: ["products", "services"],
+      filterOptions: ({ relationTo, siblingData }) => {
+        // returns a Where query dynamically by the type of relationship
+        if (relationTo === "products") {
+          return {
+            stock: { greater_than: siblingData.quantity },
+          };
+        }
+
+        if (relationTo === "services") {
+          return {
+            isAvailable: { equals: true },
+          };
+        }
+      },
+    },
+  ],
 };
 ```
 
 You can learn more about writing queries [here](/docs/queries/overview).
 
 <Banner type="warning">
-  <strong>Note:</strong><br/>
-  When a relationship field has both <strong>filterOptions</strong> and a custom <strong>validate</strong> function, the api will not validate <strong>filterOptions</strong> unless you call the default relationship field validation function imported from <strong>payload/fields/validations</strong> in your validate function.
+  <strong>Note:</strong>
+  <br />
+  When a relationship field has both <strong>filterOptions</strong> and a custom{" "}
+  <strong>validate</strong> function, the api will not validate{" "}
+  <strong>filterOptions</strong> unless you call the default relationship field
+  validation function imported from <strong>payload/fields/validations</strong>{" "}
+  in your validate function.
 </Banner>
 
 ### How the data is saved
@@ -123,10 +145,10 @@ The most simple pattern of a relationship is to use `hasMany: false` with a `rel
 The shape of the data to save for a document with the field configured this way would be:
 
 ```json
-  {
-     // Mongo ObjectID of the related user
-    "owner": "6031ac9e1289176380734024"
-  }
+{
+  // MongoDB ObjectID of the related user
+  "owner": "6031ac9e1289176380734024"
+}
 ```
 
 When querying documents in this collection via REST API, you could query as follows:
@@ -154,12 +176,12 @@ Also known as **dynamic references**, in this configuration, the `relationTo` fi
 The shape of the data to save for a document with more than one relationship type would be:
 
 ```json
-  {
-    "owner": {
-      "relationTo": "organizations",
-      "value": "6031ac9e1289176380734024"
-    }
+{
+  "owner": {
+    "relationTo": "organizations",
+    "value": "6031ac9e1289176380734024"
   }
+}
 ```
 
 Here is an example for how to query documents by this data (note the difference in referencing the `owner.value`):
@@ -193,9 +215,9 @@ The `hasMany` tells Payload that there may be more than one collection saved to
 To save the to `hasMany` relationship field we need to send an array of IDs:
 
 ```json
-  {
-    "owners": [ "6031ac9e1289176380734024", "602c3c327b811235943ee12b" ]
-  }
+{
+  "owners": ["6031ac9e1289176380734024", "602c3c327b811235943ee12b"]
+}
 ```
 
 When querying documents, the format does not change for arrays:
@@ -227,7 +249,8 @@ Relationship fields with `hasMany` set to more than one kind of collections save
     {
       "relationTo": "users",
       "value": "6031ac9e1289176380734024"
-    }, {
+    },
+    {
       "relationTo": "organizations",
       "value": "602c3c327b811235943ee12b"
     }

docs/fields/rich-text.mdx

@@ -20,7 +20,7 @@ The Admin component is built on the powerful [`slatejs`](https://docs.slatejs.or
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
 | **`saveToJWT`**      | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
@@ -31,6 +31,7 @@ The Admin component is built on the powerful [`slatejs`](https://docs.slatejs.or
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -54,6 +55,7 @@ The default `elements` available in Payload are:
 - `h4`
 - `h5`
 - `h6`
+- `blockquote`
 - `link`
 - `ol`
 - `ul`
@@ -81,6 +83,8 @@ Set this property to `true` to hide this field's gutter within the admin panel.
 
 This allows [fields](/docs/fields/overview) to be saved as extra fields on a link inside the Rich Text Editor. When this is present, the fields will render inside a modal that can be opened by clicking the "edit" button on the link element.
 
+`link.fields` may either be an array of fields (in which case all fields defined in it will be appended below the default fields) or a function that accepts the default fields as only argument and returns an array defining the entirety of fields to be used (thus providing a mechanism of overriding the default fields).
+
 ![RichText link fields](https://payloadcms.com/images/docs/fields/richText/rte-link-fields-modal.jpg)
 *RichText link with custom fields*
 
@@ -104,7 +108,7 @@ Similar to the `relationship` element, the `upload` element is a user-friendly w
 
 <Banner type="success">
   <strong>Tip:</strong><br/>
-  Collections are automatically allowed to be selected within the Rich Text relationship and upload elements by default. If you want to disable a collection from being able to be referenced in Rich Text fields, set the collection admin option of <strong>enableRichTextRelationship</strong> to false.
+  Collections are automatically allowed to be selected within the Rich Text relationship and upload elements by default. If you want to disable a collection from being able to be referenced in Rich Text fields, set the collection admin options of <strong>enableRichTextLink</strong> and <strong>enableRichTextRelationship</strong> to false.
 </Banner>
 
 Relationship and Upload elements are populated dynamically into your Rich Text field' content. Within the REST and Local APIs, any present RichText `relationship` or `upload` elements will respect the `depth` option that you pass, and will be populated accordingly. In GraphQL, each `richText` field accepts an argument of `depth` for you to utilize.
@@ -137,7 +141,7 @@ Custom `Leaf` objects follow a similar pattern but require you to define the `Le
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {
@@ -153,6 +157,7 @@ const ExampleCollection: CollectionConfig = {
           'h3',
           'h4',
           'link',
+          'blockquote',
           {
             name: 'cta',
             Button: CustomCallToActionButton,
@@ -270,7 +275,7 @@ const serialize = (children) => children.map((node, i) => {
           {serialize(node.children)}
         </h6>
       );
-    case 'quote':
+    case 'blockquote':
       return (
         <blockquote key={i}>
           {serialize(node.children)}
@@ -366,5 +371,4 @@ import type {
   RichTextCustomElement,
   RichTextCustomLeaf,
 } from 'payload/types';
-
 ```

docs/fields/row.mdx

@@ -16,6 +16,7 @@ keywords: row, fields, config, configuration, documentation, Content Management
 | ---------------- | ----------- |
 | **`fields`** *       | Array of field types to nest within this Row. |
 | **`admin`**          | Admin-specific configuration excluding `description`, `readOnly`, and `hidden`. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -25,7 +26,7 @@ keywords: row, fields, config, configuration, documentation, Content Management
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/select.mdx

@@ -15,7 +15,7 @@ keywords: select, multi-select, fields, config, configuration, documentation, Co
 
 | Option             | Description                                                                                                                                                                                         |
 | ------------------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database.                                                                                                                        |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
 | **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string.                                           |
 | **`hasMany`**      | Boolean when, if set to `true`, allows this field to have many selections instead of only one.                                                                                                      |
 | **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
@@ -30,6 +30,7 @@ keywords: select, multi-select, fields, config, configuration, documentation, Co
 | **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
 | **`required`**     | Require this field to have a value.                                                                                                                                                                 |
 | **`admin`**        | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                                            |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
@@ -61,7 +62,7 @@ Set to `true` if you'd like this field to be sortable within the Admin UI using
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/tabs.mdx

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

docs/fields/text.mdx

@@ -14,7 +14,7 @@ keywords: text, fields, config, configuration, documentation, Content Management
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database. |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`minLength`**      | Used by the default validation function to ensure values are of a minimum character length. |
@@ -29,6 +29,7 @@ keywords: text, fields, config, configuration, documentation, Content Management
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -50,7 +51,7 @@ Set this property to a string that will be used for browser autocomplete.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/textarea.mdx

@@ -14,7 +14,7 @@ keywords: textarea, fields, config, configuration, documentation, Content Manage
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`minLength`**      | Used by the default validation function to ensure values are of a minimum character length. |
@@ -25,10 +25,11 @@ keywords: textarea, fields, config, configuration, documentation, Content Manage
 | **`hooks`**          | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) |
 | **`access`**         | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |
 | **`hidden`**         | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. |
-| **`defaultValue`**   | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) [More](/docs/fields/overview#default-values) |
+| **`defaultValue`**   | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)|
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. |
 | **`required`**       | Require this field to have a value. |
 | **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -50,7 +51,7 @@ Set this property to a string that will be used for browser autocomplete.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/fields/ui.mdx

@@ -6,8 +6,11 @@ desc: UI fields are purely presentational and allow developers to customize the
 keywords: custom field, react component, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-<Banner >
-  The UI (user interface) field gives you a ton of power to add your own React components directly into the Admin panel, nested directly within your other fields. It has absolutely no effect on the data of your documents. It is presentational-only.
+<Banner>
+  The UI (user interface) field gives you a ton of power to add your own React
+  components directly into the Admin panel, nested directly within your other
+  fields. It has absolutely no effect on the data of your documents. It is
+  presentational-only.
 </Banner>
 
 This field is helpful if you need to build in custom functionality via React components within the Admin panel. Think of it as a way for you to "plug in" your own React components directly within your other fields, so you can provide your editors with new controls exactly where you want them to go.
@@ -23,34 +26,36 @@ With this field, you can also inject custom `Cell` components that appear as add
 
 ### Config
 
-| Option                       | Description                                                                                                       |
-| ---------------------------- |-------------------------------------------------------------------------------------------------------------------|
-| **`name`** *                 | A unique identifier for this field.                                                                               |
-| **`label`**                  | Human-readable label for this UI field.                                                                           |
-| **`admin.components.Field`** | React component to be rendered for this field within the Edit view. [More](/docs/admin/components/#field-component)    |
-| **`admin.components.Cell`**  | React component to be rendered as a Cell within collection List views. [More](/docs/admin/components/#field-component) |
+| Option                          | Description                                                                                                            |
+| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*                   | A unique identifier for this field.                                                                                    |
+| **`label`**                     | Human-readable label for this UI field.                                                                                |
+| **`admin.components.Field`** \* | React component to be rendered for this field within the Edit view. [More](/docs/admin/components/#field-component)    |
+| **`admin.components.Cell`**     | React component to be rendered as a Cell within collection List views. [More](/docs/admin/components/#field-component) |
+| **`custom`**                    | Extension point for adding custom data (e.g. for plugins)                                                              |
 
-*\* An asterisk denotes that a property is required.*
+_\* An asterisk denotes that a property is required._
 
 ### Example
 
 `collections/ExampleCollection.ts`
-```ts
-import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
+```ts
+import { CollectionConfig } from "payload/types";
+
+export const ExampleCollection: CollectionConfig = {
+  slug: "example-collection",
   fields: [
     {
-      type: 'ui', // required
+      name: "myCustomUIField", // required
+      type: "ui", // required
       admin: {
         components: {
           Field: MyCustomUIField,
           Cell: MyCustomUICell,
-        }
-      }
-    }
-  ]
-}
-
+        },
+      },
+    },
+  ],
+};
 ```

docs/fields/upload.mdx

@@ -25,7 +25,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
 
 | Option           | Description                                                                                                                                                                                         |
 | ---------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.                                                                                                                        |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
 | **`*relationTo`** *  | Provide a single collection `slug` to allow this field to accept a relation to. <strong>Note: the related collection must be configured to support Uploads.</strong>                                |
 | **`filterOptions`**  | A query to filter which options appear in the UI and validate against. [More](#filtering-upload-options).                                                                                           |
 | **`maxDepth`**       | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth)                                                                      |
@@ -41,6 +41,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
 | **`required`**       | Require this field to have a value.                                                                                                                                                                 |
 | **`admin`**          | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                                            |
+| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
 
 *\* An asterisk denotes that a property is required.*
 
@@ -50,7 +51,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

docs/getting-started/installation.mdx

@@ -11,11 +11,12 @@ keywords: documentation, getting started, guide, Content Management System, cms,
 Payload requires the following software:
 
 - Yarn or NPM
-- NodeJS version 10+
-- A Mongo Database
+- Node.js version 14+
+- A MongoDB Database
 
 <Banner type="warning">
-	Before proceeding any further, please ensure that you have the above requirements met.
+  Before proceeding any further, please ensure that you have the above
+  requirements met.
 </Banner>
 
 ## Quickstart with create-payload-app
@@ -26,16 +27,16 @@ To quickly scaffold a new Payload app in the fastest way possible, you can use [
 npx create-payload-app
 ```
 
-Then just follow the prompts! You can choose between a TypeScript project, which is fully supported by Payload, or a JavaScript project. You'll get set up with a new folder and a functioning Payload app inside.
+Then just follow the prompts! You'll get set up with a new folder and a functioning Payload app inside.
 
-## From scratch
+## Adding to an existing app
 
-Adding Payload to either a new or existing app is super straightforward. To add to an existing Node + Express app, just run `npm install --save --legacy-peer-deps payload`. Or, to start a new project from scratch, run `npm init` and then `npm install --save --legacy-peer-deps payload express`.
+Adding Payload to either a new or existing TypeScript + Express app is super straightforward. To add to an existing app, just run `npm install --save --legacy-peer-deps payload`.
 
-From there, the first step is writing a baseline config. Create a new `payload.config.js` in the root of your project. The simplest config contains the following:
+From there, the first step is writing a baseline config. Create a new `payload.config.ts` in your project's `/src` directory (or whatever your root TS dir is). The simplest config contains the following:
 
 ```js
-import { buildConfig } from 'payload/config';
+import { buildConfig } from "payload/config";
 
 export default buildConfig({
   // By default, Payload will boot up normally
@@ -46,46 +47,61 @@ export default buildConfig({
 
 Write the above code into your newly created config file. This baseline config will automatically provide you with a default `User` collection. For more information about users and authentication, including how to provide your own user config, jump to the [Authentication](/docs/authentication/config) section.
 
-Although this is just the bare minimum config, there are *many* more options that you can control here. To reference the full config and all of its options, [click here](/docs/configuration/overview).
+Although this is just the bare minimum config, there are _many_ more options that you can control here. To reference the full config and all of its options, [click here](/docs/configuration/overview).
 
 ### Server
 
 Now that you've got a baseline Payload config, it's time to initialize Payload. It requires an Express server that you provide, so if you're not familiar with how to set up a baseline Express server, please read up on exactly what Express is and why to use it. Express' own [Documentation](https://expressjs.com/en/starter/hello-world.html) is a good place to start. Otherwise, follow along below for how to build your own Express server to use with Payload.
 
 1. Run `npm install --save --legacy-peer-deps express` if you have not done so already
-1. Create a new `server.js` file in the root folder of your app
-1. Add the following code to `server.js`:
+1. Create a new `server.ts` file in the root directory of your app
+1. Add the following code to `server.ts`:
 
-```js
-const express = require('express');
+```ts
+import express from "express";
 
 const app = express();
 
 app.listen(3000, async () => {
-	console.log('Express is now listening for incoming connections on port 3000.')
+  console.log(
+    "Express is now listening for incoming connections on port 3000."
+  );
 });
 ```
 
-This server doesn't do anything just yet. But, after you have this in place, we can initialize Payload via its `init()` method, which accepts a small set of arguments to tell it how to operate. For a full list of `init` arguments, please consult the [main configuration](/docs/configuration/overview#init) docs.
+This server doesn't do anything just yet. But, after you have this in place, we can initialize Payload via its asynchronous `init()` method, which accepts a small set of arguments to tell it how to operate.
 
-To initialize Payload, update your `server.js` file to reflect the following code:
+To initialize Payload, update your `server.ts` file to reflect the following code:
 
-```js
-const express = require('express');
-const payload = require('payload');
+```ts
+import express from "express";
+import payload from "payload";
 
+require("dotenv").config();
 const app = express();
 
-payload.init({
-  secret: 'SECRET_KEY',
-  mongoURL: 'mongodb://localhost/payload',
-  express: app,
-})
+const start = async () => {
+  await payload.init({
+    secret: process.env.PAYLOAD_SECRET,
+    mongoURL: process.env.MONGODB_URI,
+    express: app,
+  });
 
-app.listen(3000, async () => {
-	console.log('Express is now listening for incoming connections on port 3000.')
-});
+  app.listen(3000, async () => {
+    console.log(
+      "Express is now listening for incoming connections on port 3000."
+    );
+  });
+};
 
+start();
+```
+
+A quick reminder: in this configuration, we're making use of two environmental variables, `process.env.PAYLOAD_SECRET` and `process.env.MONGODB_URI`. Often, it's smart to store these values in an `.env` file at the root of your directory and set different values for each of your environments (local, stage, prod, etc). The `dotenv` package is very handy and works well alongside of Payload. A typical `.env` file will look like this:
+
+```
+MONGODB_URI=mongodb://127.0.0.1/your-payload-app
+PAYLOAD_SECRET=your-payload-secret
 ```
 
 Here is a list of all properties available to pass through `payload.init`:
@@ -96,19 +112,21 @@ Here is a list of all properties available to pass through `payload.init`:
 
 ##### `secret`
 
-**Required**. This is a secure string that will be used to authenticate with Payload. It can be random but should be at least 14 characters and be very difficult to guess. Often, it's smart to store this value in an `env` and set different values for each of your environments (local, stage, prod, etc). The `dotenv` package is very handy and works well alongside of Payload.
+**Required**. This is a secure string that will be used to authenticate with Payload. It can be random but should be at least 14 characters and be very difficult to guess.
+
+Payload uses this secret key to generate secure user tokens (JWT). Behind the scenes, we do not use your secret key to encrypt directly - instead, we first take the secret key and create an encrypted string using the SHA-256 hash function. Then, we reduce the encrypted string to its first 32 characters. This final value is what Payload uses for encryption.
 
 ##### `mongoURL`
 
-**Required**. This is a fully qualified MongoDB connection string that points to your Mongo database. If you don't have Mongo installed locally, you can [follow these steps for Mac OSX](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) and [these steps](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/) for Windows 10. If you want to use a local database and you know you have MongoDB installed locally, a typical connection string will look like this:
+**Required**. This is a fully qualified MongoDB connection string that points to your MongoDB database. If you don't have MongoDB installed locally, you can [follow these steps for Mac OSX](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) and [these steps](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/) for Windows 10. If you want to use a local database and you know you have MongoDB installed locally, a typical connection string will look like this:
 
-`mongodb://localhost/payload`
+`mongodb://127.0.0.1/payload`
 
-In contrast to running Mongo locally, a popular option is to sign up for a free [MongoDB Atlas account](https://www.mongodb.com/cloud/atlas), which is a fully hosted and cloud-based installation of Mongo that you don't need to ever worry about.
+In contrast to running MongoDB locally, a popular option is to sign up for a free [MongoDB Atlas account](https://www.mongodb.com/cloud/atlas), which is a fully hosted and cloud-based installation of MongoDB that you don't need to ever worry about.
 
 ##### `mongoOptions`
 
-Customize Mongo connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose.
+Customize MongoDB connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose.
 
 ##### `email`
 
@@ -128,6 +146,10 @@ A function that is called immediately following startup that receives the Payloa
 
 ### Test it out
 
-After you've gotten this far, it's time to boot up Payload. At the command line, run `npm install` and then `node server.js` in your application's folder to start up your app and initialize Payload.
+After you've gotten this far, it's time to boot up Payload. Start your project in your application's folder to get going.
 
 After it starts, you can go to `http://localhost:3000/admin` to create your first Payload user!
+
+### Docker
+
+Looking to deploy Payload with Docker? New projects with `create-payload-app` come with a Dockerfile and docker-compose.yml file ready to go. Examples of these files can be seen in our [Deployment docs](/docs/production/deployment#docker).

docs/getting-started/what-is-payload.mdx

@@ -8,7 +8,7 @@ keywords: documentation, getting started, guide, Content Management System, cms,
 
 <YouTube
   id="In_lFhzmbME"
-  title="Payload CMS Introduction - Closing the Gap Between Headless CMS and Application Frameworks"
+  title="Payload Introduction - Closing the Gap Between Headless CMS and Application Frameworks"
 />
 
 <Banner type="success">
@@ -19,7 +19,7 @@ keywords: documentation, getting started, guide, Content Management System, cms,
 
 Out of the box, Payload gives you a lot of the things that you often need when developing a new website, web app, or native app:
 
-- A Mongo database to store your data
+- A MongoDB database to store your data
 - A way to store, retrieve, and manipulate data of any shape via full REST and GraphQL APIs
 - Authentication—complete with commonly required functionality like registration, email verification, login, & password reset
 - Deep access control to your data, based on document or field-level functions

docs/graphql/extending.mdx

@@ -53,13 +53,13 @@ export default buildConfig({
                 type: GraphQL.GraphQLFloat,
               },
             },
-            args: {
-              argNameHere: {
-                type: new GraphQL.GraphQLNonNull(GraphQLString),
-              }
-            },
-            resolve: myCustomQueryResolver,
-          })
+          }),
+          args: {
+            argNameHere: {
+              type: new GraphQL.GraphQLNonNull(GraphQLString),
+            }
+          },
+          resolve: myCustomQueryResolver,
         }
       }
     }
@@ -67,3 +67,90 @@ export default buildConfig({
   }
 })
 ```
+
+### Resolver function
+
+In your resolver, make sure you set `depth: 0` if you're returning data directly from the local API so that GraphQL can correctly resolve queries to nested values such as relationship data.
+
+Your function will receive four arguments you can make use of:
+
+Example
+
+```ts
+async (obj, args, context, info) => { }
+```
+
+**`obj`** 
+
+The previous object. Not very often used and usually discarded.
+
+**`args`**
+
+The available arguments from your query or mutation will be available to you here, these must be configured via the custom operation first.
+
+**`context`**
+
+An object containing the `req` and `res` objects that will provide you with the `payload`, `user` instances and more, like any other Payload API handler.
+
+**`info`**
+
+Contextual information about the currently running GraphQL operation. You can get schema information from this as well as contextual information about where this resolver function is being run.
+
+### Types
+
+We've exposed a few types and utilities to help you extend the API further. Payload uses the GraphQL.js package for which you can view the full list of available types in the [official documentation](https://graphql.org/graphql-js/type/).
+
+**`GraphQL`**
+
+You can directly import the GraphQL package used by Payload, most useful for typing. For queries, mutations and handlers make sure you use the `GraphQL` and `payload` instances provided via arguments.
+
+**`buildPaginatedListType`**
+
+This is a utility function that allows you to build a new GraphQL type for a paginated result similar to the Payload's generated schema.
+It takes in two arguments, the first for the name of this new schema type and the second for the GraphQL type to be used in the docs parameter.
+
+Example
+
+```ts
+export const getMyPosts = (GraphQL, payload) => {
+  return {
+    args: {},
+    resolve: Resolver,
+    // The name of your new type has to be unique
+    type: buildPaginatedListType('AuthorPosts', payload.collections['posts'].graphQL?.type),
+  }
+}
+```
+
+**`payload.collections.slug.graphQL`**
+
+If you want to extend more of the provided API then the `graphQL` object on your collection slug will contain additional types to help you re-use code for types, mutations and queries.
+
+```ts
+graphQL?: {
+  type: GraphQLObjectType
+  paginatedType: GraphQLObjectType
+  JWT: GraphQLObjectType
+  versionType: GraphQLObjectType
+  whereInputType: GraphQLInputObjectType
+  mutationInputType: GraphQLNonNull<any>
+  updateMutationInputType: GraphQLNonNull<any>
+}
+```
+
+### Best practices
+
+There are a few ways to structure your code, we recommend using a dedicated `graphql` directory so you can keep all of your logic in one place. You have total freedom of how you want to structure this but a common pattern is to group functions by type and with their resolver.
+
+Example
+
+```
+src/graphql
+---- queries/
+     index.ts
+    -- myCustomQuery/
+       index.ts
+       resolver.ts
+
+---- mutations/
+```

docs/graphql/graphql-schema.mdx

@@ -8,7 +8,7 @@ keywords: headless cms, typescript, documentation, Content Management System, cm
 
 When working with GraphQL it is useful to have the schema for development of other projects that need to call on your GraphQL endpoint. In Payload the schema is controlled by your collections and globals and is made available to the developer or third parties, it is not necessary for developers using Payload to write schema types manually.
 
-### GraphQL Schema generate script
+### Schema generatation script
 
 Run the following command in a Payload project to generate your project's GraphQL schema from Payload:
 
@@ -16,9 +16,9 @@ Run the following command in a Payload project to generate your project's GraphQ
 payload generate:graphQLSchema
 ```
 
-You can run this command whenever you need to regenerate your graphQL schema and output it to a file, and then you can use the schema for writing your own graphQL elsewhere in other projects.
+You can run this command whenever you need to regenerate your GraphQL schema and output it to a file, and then you can use the schema for writing your own GraphQL elsewhere in other projects.
 
-### GraphQL schema output file
+### Custom output file path
 
 ```js
 {
@@ -29,12 +29,51 @@ You can run this command whenever you need to regenerate your graphQL schema and
 }
 ```
 
+### Custom Field Schemas
+
+For `array`, `block`, `group` and named `tab` fields, you can generate top level reusable interfaces. The following group field config:
+
+```ts
+{
+  type: 'group',
+  name: 'meta',
+  interfaceName: 'SharedMeta', <-- here!!
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+    },
+    {
+      name: 'description',
+      type: 'text',
+    },
+  ],
+}
+```
+
+will generate:
+
+```ts
+// a top level reusable type!!
+type SharedMeta {
+  title: String
+  description: String
+}
+
+// example usage inside collection schema
+type Collection1 {
+  // ...other fields
+  meta: SharedMeta
+}
+```
+
 The above example outputs all your definitions to a file relative from your payload config as `./graphql/schema.graphql`. By default, the file will be output to your current working directory as `schema.graphql`.
 
 #### Adding an NPM script
 
 <Banner type="warning">
-  <strong>Important:</strong><br/>
+  <strong>Important</strong>
+  <br />
   Payload needs to be able to find your config to generate your GraphQL schema.
 </Banner>
 
@@ -45,8 +84,8 @@ To add an NPM script to generate your types and show Payload where to find your
 ```json
 {
   "scripts": {
-    "generate:graphQLSchema": "PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema",
-  },
+    "generate:graphQLSchema": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema"
+  }
 }
 ```
 

docs/graphql/overview.mdx

@@ -16,13 +16,13 @@ The labels you provide for your Collections and Globals are used to name the Gra
 
 At the top of your Payload config you can define all the options to manage GraphQL.
 
-| Option               | Description  |
-| -------------------- | -------------|
-| `mutations`                     | Any custom Mutations to be added in addition to what Payload provides. [More](/docs/graphql/extending) |
-| `queries`                       | Any custom Queries to be added in addition to what Payload provides. [More](/docs/graphql/extending) |
-| `maxComplexity`                 | A number used to set the maximum allowed complexity allowed by requests [More](/docs/graphql/overview#query-complexity-limits) |
-| `disablePlaygroundInProduction` | A boolean that if false will enable the graphQL playground, defaults to true. [More](/docs/graphql/overview#graphql-playground) |
-| `disable`                       | A boolean that if true will disable the graphQL entirely, defaults to false. |
+| Option                          | Description                                                                                                                                                   |
+| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `mutations`                     | Any custom Mutations to be added in addition to what Payload provides. [More](/docs/graphql/extending)                                                        |
+| `queries`                       | Any custom Queries to be added in addition to what Payload provides. [More](/docs/graphql/extending)                                                          |
+| `maxComplexity`                 | A number used to set the maximum allowed complexity allowed by requests [More](/docs/graphql/overview#query-complexity-limits)                                |
+| `disablePlaygroundInProduction` | A boolean that if false will enable the GraphQL playground, defaults to true. [More](/docs/graphql/overview#graphql-playground)                               |
+| `disable`                       | A boolean that if true will disable the GraphQL entirely, defaults to false.                                                                                  |
 | `schemaOutputFile`              | A string for the file path used by the generate schema command. Defaults to `graphql.schema` next to `payload.config.ts` [More](/docs/graphql/graphql-schema) |
 
 ## Collections
@@ -32,7 +32,7 @@ Everything that can be done to a Collection via the REST or Local API can be don
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const PublicUser: CollectionConfig = {
+export const PublicUser: CollectionConfig = {
   slug: 'public-users',
   auth: true, // Auth is enabled
   fields: [
@@ -43,26 +43,26 @@ const PublicUser: CollectionConfig = {
 
 **Payload will automatically open up the following queries:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`PublicUser`**       | `findByID` |
-| **`PublicUsers`**      | `find` |
-| **`mePublicUser`**     | `me` auth operation |
+| Query Name         | Operation           |
+| ------------------ | ------------------- |
+| **`PublicUser`**   | `findByID`          |
+| **`PublicUsers`**  | `find`              |
+| **`mePublicUser`** | `me` auth operation |
 
 **And the following mutations:**
 
-| Query Name                     | Operation    |
-| ------------------------------ | -------------|
-| **`createPublicUser`**         | `create` |
-| **`updatePublicUser`**         | `update` |
-| **`deletePublicUser`**         | `delete` |
+| Query Name                     | Operation                       |
+| ------------------------------ | ------------------------------- |
+| **`createPublicUser`**         | `create`                        |
+| **`updatePublicUser`**         | `update`                        |
+| **`deletePublicUser`**         | `delete`                        |
 | **`forgotPasswordPublicUser`** | `forgotPassword` auth operation |
-| **`resetPasswordPublicUser`**  | `resetPassword` auth operation |
-| **`unlockPublicUser`**         | `unlock` auth operation |
-| **`verifyPublicUser`**         | `verify` auth operation |
-| **`loginPublicUser`**          | `login` auth operation |
-| **`logoutPublicUser`**         | `logout` auth operation |
-| **`refreshTokenPublicUser`**   | `refresh` auth operation |
+| **`resetPasswordPublicUser`**  | `resetPassword` auth operation  |
+| **`unlockPublicUser`**         | `unlock` auth operation         |
+| **`verifyPublicUser`**         | `verify` auth operation         |
+| **`loginPublicUser`**          | `login` auth operation          |
+| **`logoutPublicUser`**         | `logout` auth operation         |
+| **`refreshTokenPublicUser`**   | `refresh` auth operation        |
 
 ## Globals
 
@@ -81,32 +81,32 @@ const Header: GlobalConfig = {
 
 **Payload will open the following query:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`Header`**           | `findOne`    |
+| Query Name   | Operation |
+| ------------ | --------- |
+| **`Header`** | `findOne` |
 
 **And the following mutation:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`updateHeader`**     | `update`     |
+| Query Name         | Operation |
+| ------------------ | --------- |
+| **`updateHeader`** | `update`  |
 
 ## Preferences
 
-User [preferences](/docs/admin/overview#preferences)  for the admin panel are also available to GraphQL. To query preferences you must supply an authorization token in the header and only the preferences of that user will be accessible and of the `key` argument.
+User [preferences](/docs/admin/overview#preferences) for the admin panel are also available to GraphQL. To query preferences you must supply an authorization token in the header and only the preferences of that user will be accessible and of the `key` argument.
 
 **Payload will open the following query:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`Preference`**       | `findOne`    |
+| Query Name       | Operation |
+| ---------------- | --------- |
+| **`Preference`** | `findOne` |
 
 **And the following mutations:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`updatePreference`** | `update`     |
-| **`deletePreference`** | `delete`     |
+| Query Name             | Operation |
+| ---------------------- | --------- |
+| **`updatePreference`** | `update`  |
+| **`deletePreference`** | `delete`  |
 
 ## GraphQL Playground
 
@@ -115,8 +115,16 @@ GraphQL Playground is enabled by default for development purposes, but disabled
 You can even log in using the `login[collection-singular-label-here]` mutation to use the Playground as an authenticated user.
 
 <Banner type="success">
-  <strong>Tip:</strong><br/>
-  To see more regarding how the above queries and mutations are used, visit your GraphQL playground (by default at <a href="http://localhost:3000/api/graphql-playground">(http://localhost:3000/api/graphql-playground</a>) while your server is running. There, you can use the "Schema" and "Docs" buttons on the right to see a ton of detail about how GraphQL operates within Payload.
+  <strong>Tip:</strong>
+  <br />
+  To see more regarding how the above queries and mutations are used, visit your
+  GraphQL playground (by default at{" "}
+  <a href="http://localhost:3000/api/graphql-playground">
+    (http://localhost:3000/api/graphql-playground
+  </a>
+  ) while your server is running. There, you can use the "Schema" and "Docs"
+  buttons on the right to see a ton of detail about how GraphQL operates within
+  Payload.
 </Banner>
 
 ## Query complexity limits

docs/hooks/collections.mdx

@@ -34,7 +34,7 @@ All collection Hook properties accept arrays of synchronous or asynchronous func
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleHooks: CollectionConfig = {
+export const ExampleHooks: CollectionConfig = {
   slug: 'example-hooks',
   fields: [
     { name: 'name', type: 'text'},
@@ -79,7 +79,13 @@ const beforeOperationHook: CollectionBeforeOperationHook = async ({
 
 ### beforeValidate
 
-Runs before the `create` and `update` operations. This hook allows you to add or format data before the incoming data is validated.
+Runs before the `create` and `update` operations. This hook allows you to add or format data before the incoming data is validated server-side.
+
+Please do note that this does not run before the client-side validation. If you added a `validate` function, this would be the lifecycle:
+
+1. `validate` runs on the client
+2. if successful, `beforeValidate` runs on the server
+3. `validate` runs on the server
 
 ```ts
 import { CollectionBeforeOperationHook } from 'payload/types';

docs/hooks/fields.mdx

@@ -67,6 +67,7 @@ Field Hooks receive one `args` argument that contains the following properties:
 | **`previousSiblingDoc`** | The sibling data from the previous document in `afterChange` hook.                                                                                                                                                    |
 | **`req`**                | The Express `request` object. It is mocked for Local API operations.                                                                                                                                                  |
 | **`value`**              | The value of the field.                                                                                                                                                                                               |
+| **`previousValue`**      | The previous value of the field, before changes were applied, only in `afterChange` hooks.                                                                                                                            |
 
 #### Return value
 

docs/hooks/globals.mdx

@@ -8,11 +8,11 @@ keywords: hooks, globals, config, configuration, documentation, Content Manageme
 
 Globals feature the ability to define the following hooks:
 
-- [beforeValidate](#beforeValidate)
-- [beforeChange](#beforeChange)
-- [afterChange](#afterChange)
-- [beforeRead](#beforeRead)
-- [afterRead](#afterRead)
+- [beforeValidate](#beforevalidate)
+- [beforeChange](#beforechange)
+- [afterChange](#afterchange)
+- [beforeRead](#beforeread)
+- [afterRead](#afterread)
 
 ## Config
 

docs/local-api/overview.mdx

@@ -9,8 +9,14 @@ keywords: local api, config, configuration, documentation, Content Management Sy
 The Payload Local API gives you the ability to execute the same operations that are available through REST and GraphQL within Node, directly on your server. Here, you don't need to deal with server latency or network speed whatsoever and can interact directly with your database.
 
 <Banner type="success">
-  <strong>Tip:</strong><br/>
-  The Local API is incredibly powerful when used with server-side rendering app frameworks like NextJS. With other headless CMS, you need to request your data from third-party servers which can add significant loading time to your server-rendered pages. With Payload, you don't have to leave your server to gather the data you need. It can be incredibly fast and is definitely a game changer.
+  <strong>Tip:</strong>
+  <br />
+  The Local API is incredibly powerful when used with server-side rendering app
+  frameworks like NextJS. With other headless CMS, you need to request your data
+  from third-party servers which can add significant loading time to your
+  server-rendered pages. With Payload, you don't have to leave your server to
+  gather the data you need. It can be incredibly fast and is definitely a game
+  changer.
 </Banner>
 
 Here are some common examples of how you can use the Local API:
@@ -28,15 +34,16 @@ You can gain access to the currently running `payload` object via two ways:
 You can import or require `payload` into your own files after it's been initialized, but you need to make sure that your `import` / `require` statements come **after** you call `payload.init()`—otherwise Payload won't have been initialized yet. That might be obvious. To us, it's usually not.
 
 Example:
+
 ```ts
-import payload from 'payload';
-import { CollectionAfterChangeHook } from 'payload/types';
+import payload from "payload";
+import { CollectionAfterChangeHook } from "payload/types";
 
 const afterChangeHook: CollectionAfterChangeHook = async () => {
   const posts = await payload.find({
-    collection: 'posts',
+    collection: "posts",
   });
-}
+};
 ```
 
 ##### Accessing from the `req`
@@ -44,35 +51,41 @@ const afterChangeHook: CollectionAfterChangeHook = async () => {
 Payload is available anywhere you have access to the Express `req` - including within your access control and hook functions.
 
 Example:
+
 ```ts
-const afterChangeHook: CollectionAfterChangeHook = async ({ req: { payload }}) => {
+const afterChangeHook: CollectionAfterChangeHook = async ({
+  req: { payload },
+}) => {
   const posts = await payload.find({
-    collection: 'posts',
+    collection: "posts",
   });
-}
+};
 ```
 
 ### Local options available
 
 You can specify more options within the Local API vs. REST or GraphQL due to the server-only context that they are executed in.
 
-| Local Option         | Description  |
-| -------------------- | ------------ |
-| `collection`         | Required for Collection operations. Specifies the Collection slug to operate against. |
-| `data`               | The data to use within the operation. Required for `create`, `update`. |
-| `depth`              | [Control auto-population](/docs/getting-started/concepts#depth) of nested relationship and upload fields. |
-| `locale`             | Specify [locale](/docs/configuration/localization) for any returned documents. |
-| `fallbackLocale`     | Specify a [fallback locale](/docs/configuration/localization) to use for any returned documents. |
-| `overrideAccess`     | Skip access control. By default, this property is set to true within all Local API operations.  |
-| `user`               | If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks. |
-| `showHiddenFields`   | Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config. |
-| `pagination`         | Set to false to return all documents and avoid querying for document counts. |
+| Local Option       | Description                                                                                                          |
+| ------------------ | -------------------------------------------------------------------------------------------------------------------- |
+| `collection`       | Required for Collection operations. Specifies the Collection slug to operate against.                                |
+| `data`             | The data to use within the operation. Required for `create`, `update`.                                               |
+| `depth`            | [Control auto-population](/docs/getting-started/concepts#depth) of nested relationship and upload fields.            |
+| `locale`           | Specify [locale](/docs/configuration/localization) for any returned documents.                                       |
+| `fallbackLocale`   | Specify a [fallback locale](/docs/configuration/localization) to use for any returned documents.                     |
+| `overrideAccess`   | Skip access control. By default, this property is set to true within all Local API operations.                       |
+| `user`             | If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.                |
+| `showHiddenFields` | Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config. |
+| `pagination`       | Set to false to return all documents and avoid querying for document counts.                                         |
 
-*There are more options available on an operation by operation basis outlined below.*
+_There are more options available on an operation by operation basis outlined below._
 
 <Banner type="warning">
-  <strong>Note:</strong><br/>
-  By default, all access control checks are disabled in the Local API, but you can re-enable them if you'd like, as well as pass a specific user to run the operation with.
+  <strong>Note:</strong>
+  <br />
+  By default, all access control checks are disabled in the Local API, but you
+  can re-enable them if you'd like, as well as pass a specific user to run the
+  operation with.
 </Banner>
 
 ## Collections
@@ -84,12 +97,13 @@ The following Collection operations are available through the Local API:
 ```js
 // The created Post document is returned
 const post = await payload.create({
-  collection: 'posts', // required
-  data: { // required
-    title: 'sure',
-    description: 'maybe',
+  collection: "posts", // required
+  data: {
+    // required
+    title: "sure",
+    description: "maybe",
   },
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUserDoc,
   overrideAccess: true,
@@ -102,12 +116,12 @@ const post = await payload.create({
   // If your collection supports uploads, you can upload
   // a file directly through the Local API by providing
   // its full, absolute file path.
-  filePath: path.resolve(__dirname, './path-to-image.jpg'),
+  filePath: path.resolve(__dirname, "./path-to-image.jpg"),
 
   // Alternatively, you can directly pass a File,
   // if file is provided, filePath will be omitted
   file: uploadedFile,
-})
+});
 ```
 
 #### Find
@@ -116,18 +130,18 @@ const post = await payload.create({
 // Result will be a paginated set of Posts.
 // See /docs/queries/pagination for more.
 const result = await payload.find({
-  collection: 'posts', // required
+  collection: "posts", // required
   depth: 2,
   page: 1,
   limit: 10,
   where: {}, // pass a `where` query here
-  sort: '-title',
-  locale: 'en',
+  sort: "-title",
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 #### Find by ID
@@ -135,30 +149,31 @@ const result = await payload.find({
 ```js
 // Result will be a Post document.
 const result = await payload.findByID({
-  collection: 'posts', // required
-  id: '507f1f77bcf86cd799439011', // required
+  collection: "posts", // required
+  id: "507f1f77bcf86cd799439011", // required
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
-#### Update
+#### Update by ID
 
 ```js
 // Result will be the updated Post document.
 const result = await payload.update({
-  collection: 'posts', // required
-  id: '507f1f77bcf86cd799439011', // required
-  data: { // required
-    title: 'sure',
-    description: 'maybe',
+  collection: "posts", // required
+  id: "507f1f77bcf86cd799439011", // required
+  data: {
+    // required
+    title: "sure",
+    description: "maybe",
   },
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
@@ -167,13 +182,51 @@ const result = await payload.update({
   // If your collection supports uploads, you can upload
   // a file directly through the Local API by providing
   // its full, absolute file path.
-  filePath: path.resolve(__dirname, './path-to-image.jpg'),
+  filePath: path.resolve(__dirname, "./path-to-image.jpg"),
 
   // If you are uploading a file and would like to replace
   // the existing file instead of generating a new filename,
   // you can set the following property to `true`
   overwriteExistingFiles: true,
-})
+});
+```
+
+#### Update Many
+
+```js
+// Result will be an object with:
+// {
+//   docs: [], // each document that was updated
+//   errors: [], // each error also includes the id of the document
+// }
+const result = await payload.update({
+  collection: "posts", // required
+  where: {
+    // required
+    fieldName: { equals: "value" },
+  },
+  data: {
+    // required
+    title: "sure",
+    description: "maybe",
+  },
+  depth: 0,
+  locale: "en",
+  fallbackLocale: false,
+  user: dummyUser,
+  overrideAccess: false,
+  showHiddenFields: true,
+
+  // If your collection supports uploads, you can upload
+  // a file directly through the Local API by providing
+  // its full, absolute file path.
+  filePath: path.resolve(__dirname, "./path-to-image.jpg"),
+
+  // If you are uploading a file and would like to replace
+  // the existing file instead of generating a new filename,
+  // you can set the following property to `true`
+  overwriteExistingFiles: true,
+});
 ```
 
 #### Delete
@@ -181,15 +234,38 @@ const result = await payload.update({
 ```js
 // Result will be the now-deleted Post document.
 const result = await payload.delete({
-  collection: 'posts', // required
-  id: '507f1f77bcf86cd799439011', // required
+  collection: "posts", // required
+  id: "507f1f77bcf86cd799439011", // required
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
+```
+
+#### Delete Many
+
+```js
+// Result will be an object with:
+// {
+//   docs: [], // each document that is now deleted
+//   errors: [], // any errors that occurred, including the id of the errored on document
+// }
+const result = await payload.delete({
+  collection: "posts", // required
+  where: {
+    // required
+    fieldName: { equals: "value" },
+  },
+  depth: 0,
+  locale: "en",
+  fallbackLocale: false,
+  user: dummyUser,
+  overrideAccess: false,
+  showHiddenFields: true,
+});
 ```
 
 ## Auth Operations
@@ -207,19 +283,20 @@ If a collection has [`Authentication`](/docs/authentication/overview) enabled, a
 // }
 
 const result = await payload.login({
-  collection: 'users', // required
-  data: { // required
-    email: 'dev@payloadcms.com',
-    password: 'rip',
+  collection: "users", // required
+  data: {
+    // required
+    email: "dev@payloadcms.com",
+    password: "rip",
   },
   req: req, // pass an Express `req` which will be provided to all hooks
   res: res, // used to automatically set an HTTP-only auth cookie
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 #### Forgot Password
@@ -227,12 +304,13 @@ const result = await payload.login({
 ```js
 // Returned token will allow for a password reset
 const token = await payload.forgotPassword({
-  collection: 'users', // required
-  data: { // required
-    email: 'dev@payloadcms.com',
+  collection: "users", // required
+  data: {
+    // required
+    email: "dev@payloadcms.com",
   },
   req: req, // pass an Express `req` which will be provided to all hooks
-})
+});
 ```
 
 #### Reset Password
@@ -244,13 +322,14 @@ const token = await payload.forgotPassword({
 //   user: { ... } // the user document that just logged in
 // }
 const result = await payload.forgotPassword({
-  collection: 'users', // required
-  data: { // required
-    token: 'afh3o2jf2p3f...', // the token generated from the forgotPassword operation
+  collection: "users", // required
+  data: {
+    // required
+    token: "afh3o2jf2p3f...", // the token generated from the forgotPassword operation
   },
   req: req, // pass an Express `req` which will be provided to all hooks
   res: res, // used to automatically set an HTTP-only auth cookie
-})
+});
 ```
 
 #### Unlock
@@ -258,13 +337,14 @@ const result = await payload.forgotPassword({
 ```js
 // Returned result will be a boolean representing success or failure
 const result = await payload.unlock({
-  collection: 'users', // required
-  data: { // required
-    email: 'dev@payloadcms.com',
+  collection: "users", // required
+  data: {
+    // required
+    email: "dev@payloadcms.com",
   },
   req: req, // pass an Express `req` which will be provided to all hooks
   overrideAccess: true,
-})
+});
 ```
 
 #### Verify
@@ -272,9 +352,9 @@ const result = await payload.unlock({
 ```js
 // Returned result will be a boolean representing success or failure
 const result = await payload.verify({
-  collection: 'users', // required
-  token: 'afh3o2jf2p3f...', // the token saved on the user as `_verificationToken`
-})
+  collection: "users", // required
+  token: "afh3o2jf2p3f...", // the token saved on the user as `_verificationToken`
+});
 ```
 
 ## Globals
@@ -286,14 +366,14 @@ The following Global operations are available through the Local API:
 ```js
 // Result will be the Header Global.
 const result = await payload.findGlobal({
-  slug: 'header', // required
+  slug: "header", // required
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 #### Update
@@ -301,44 +381,79 @@ const result = await payload.findGlobal({
 ```js
 // Result will be the updated Header Global.
 const result = await payload.updateGlobal({
-  slug: 'header', // required
-  data: { // required
+  slug: "header", // required
+  data: {
+    // required
     nav: [
       {
-        url: 'https://google.com',
+        url: "https://google.com",
       },
       {
-        url: 'https://payloadcms.com',
+        url: "https://payloadcms.com",
       },
     ],
   },
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
+```
+
+## Example Script using Local API
+
+The Local API is especially useful for running scripts
+
+```ts
+import payload from "payload";
+import path from "path";
+import dotenv from "dotenv";
+
+dotenv.config({
+  path: path.resolve(__dirname, "../.env"),
+});
+
+const { PAYLOAD_SECRET, MONGODB_URI } = process.env;
+
+const doAction = async (): Promise<void> => {
+  await payload.init({
+    secret: PAYLOAD_SECRET,
+    mongoURL: MONGODB_URI,
+    local: true, // Enables local mode, doesn't spin up a server or frontend
+  });
+
+  // Perform any Local API operations here
+  await payload.find({
+    collection: "posts",
+    // where: {} // optional
+  });
+
+  await payload.create({
+    collection: "posts",
+    data: {},
+  });
+};
+
+doAction();
 ```
 
 ## TypeScript
 
-Local API calls also support passing in a generic. This is especially useful if you generate your TS types using a [generate types script](/docs/typescript/generating-types).
+Local API calls will automatically infer your [generated types](/docs/typescript/generating-types).
 
 Here is an example of usage:
 
 ```ts
-// Our generated types
-import { Post } from './payload-types'
-
-// Add Post types as generic to create function
-const post: Post = await payload.create<Post>({
-  collection: 'posts',
+// Properly inferred as `Post` type
+const post = await payload.create({
+  collection: "posts",
 
   // Data will now be typed as Post and give you type hints
   data: {
-    title: 'my title',
-    description: 'my description',
+    title: "my title",
+    description: "my description",
   },
-})
+});
 ```

docs/production/deployment.mdx

@@ -12,9 +12,15 @@ keywords: deployment, production, config, configuration, documentation, Content
 
 There are many ways to deploy Payload to a production environment. When evaluating how you will deploy Payload, you need to consider these main aspects:
 
+1. [Basics](#basics)
 1. [Security](#security)
 1. [Your MongoDB](#mongodb)
 1. [Permanent File Storage](#file-storage)
+1. [Docker](#docker)
+
+## Basics
+
+In order for Payload to run, it requires both the server code and the built admin panel. These will be the `dist` and `build` directories by default. If you've used `create-payload-app` to create your project, executing the `build` npm script will build both and output these directories.
 
 ## Security
 
@@ -41,7 +47,7 @@ Before running in Production, you need to have built a production-ready copy of
 {
   "name": "project-name-here",
   "scripts": {
-    "build": "payload build",
+    "build": "payload build"
   },
   "dependencies": {
     // your dependencies
@@ -64,6 +70,8 @@ Payload comes with a robust set of built-in anti-abuse measures, such as locking
 
 ## MongoDB
 
+Payload can be used with any MongoDB compatible database including AWS DocumentDB or Azure Cosmos DB.
+
 ##### Managing MongoDB yourself
 
 If you are using a [persistent filesystem-based cloud host](#persistent-vs-ephemeral-filesystems) such as a [DigitalOcean Droplet](https://www.digitalocean.com/products/droplets/) or an [Amazon EC2](https://aws.amazon.com/ec2/?ec2-whats-new.sort-by=item.additionalFields.postDateTime&ec2-whats-new.sort-order=desc) server, you might opt to install MongoDB directly on that server itself so that Node can communicate with it locally. With this approach, you can benefit from faster response times, but scaling can become more involved as your app's user base grows.
@@ -73,10 +81,18 @@ If you are using a [persistent filesystem-based cloud host](#persistent-vs-ephem
 Alternatively, you can rely on a third-party MongoDB host such as [MongoDB Atlas](https://www.mongodb.com/). With Atlas or a similar cloud provider, you can trust them to take care of your database's availability, security, redundancy, and backups.
 
 <Banner type="warning">
-  <strong>Note regarding Azure Cosmos:</strong><br/>
-  When using Azure Cosmos, MongoDB requires an index on any field being sorted on. To make this easier, see the <a href="/docs/configuration/overview">indexSortableFields</a> configuration option.
+  <strong>Note:</strong>
+  <br />
+  If versions are enabled and a collection has many documents you may need a minimum of an m10 mongoDB atlas cluster if you reach a sorting `exceeded memory limit` error to view a collection list in the admin UI. The limitations of the m2 and m5 tier clusters are here:
+  <a href="https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/?_ga=2.176267877.1329169847.1677683154-860992573.1647438381#operational-limitations">Atlas M0 (Free Cluster), M2, and M5 Limitations</a>
 </Banner>
 
+##### DocumentDB
+When using AWS DocumentDB, you will need to configure connection options for authentication in the `mongoOptions` passed to `payload.init`. You also need to set `mongoOptions.useFacet` to `false` to disable use of the unsupported `$facet` aggregation.
+
+##### CosmosDB
+When using Azure Cosmos DB, an index is needed for any field you may want to sort on. To add the sort index for all fields that may be sorted in the admin UI use the <a href="/docs/configuration/overview">indexSortableFields</a> configuration option.
+
 ## File storage
 
 If you are using Payload to [manage file uploads](/docs/upload/overview), you need to consider where your uploaded files will be permanently stored. If you do not use Payload for file uploads, then this section does not impact your app whatsoever.
@@ -128,3 +144,77 @@ DigitalOcean provides extremely helpful documentation that can walk you through
 1. [Install and secure MongoDB](https://www.digitalocean.com/community/tutorials/how-to-install-mongodb-on-ubuntu-20-04)
 1. [Create a new MongoDB and user](https://medium.com/@mhagemann/how-to-add-a-new-user-to-a-mongodb-database-d896776b5362)
 1. [Set up Node for production](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-20-04)
+
+## Docker
+
+This is an example of a multi-stage docker build of Payload for production. Ensure you are setting your environment variables on deployment, like `PAYLOAD_SECRET`, `PAYLOAD_CONFIG_PATH`, and `MONGODB_URI` if needed.
+
+```dockerfile
+FROM node:18-alpine as base
+
+FROM base as builder
+
+WORKDIR /home/node
+COPY package*.json ./
+
+COPY . .
+RUN yarn install
+RUN yarn build
+
+FROM base as runtime
+
+ENV NODE_ENV=production
+
+WORKDIR /home/node
+COPY package*.json  ./
+
+RUN yarn install --production
+COPY --from=builder /home/node/dist ./dist
+COPY --from=builder /home/node/build ./build
+
+EXPOSE 3000
+
+CMD ["node", "dist/server.js"]
+```
+
+## Docker Compose
+
+Here is an example of a docker-compose.yml file that can be used for development
+
+```yml
+version: '3'
+
+services:
+
+  payload:
+    image: node:18-alpine
+    ports:
+      - "3000:3000"
+    volumes:
+      - .:/home/node/app
+      - node_modules:/home/node/app/node_modules
+    working_dir: /home/node/app/
+    command: sh -c "yarn install && yarn dev"
+    depends_on:
+      - mongo
+    environment:
+      MONGODB_URI: mongodb://mongo:27017/payload
+      PORT: 3000
+      NODE_ENV: development
+      PAYLOAD_SECRET: TESTING
+
+  mongo:
+    image: mongo:latest
+    ports:
+      - "27017:27017"
+    command:
+      - --storageEngine=wiredTiger
+    volumes:
+      - data:/data/db
+    logging:
+      driver: none
+
+volumes:
+  data:
+  node_modules:
+```

docs/queries/overview.mdx

@@ -17,55 +17,53 @@ Payload provides an extremely granular querying language through all APIs. Each
 For example, say you have a collection as follows:
 
 ```ts
-import { CollectionConfig } from 'payload/types';
+import { CollectionConfig } from "payload/types";
 
-const Post: CollectionConfig = {
-  slug: 'posts',
+export const Post: CollectionConfig = {
+  slug: "posts",
   fields: [
     {
-      name: 'color',
-      type: 'select',
-      options: [
-        'mint',
-        'dark-gray',
-        'white',
-      ],
+      name: "color",
+      type: "select",
+      options: ["mint", "dark-gray", "white"],
     },
     {
-      name: 'featured',
-      type: 'checkbox',
-    }
-  ]
-}
+      name: "featured",
+      type: "checkbox",
+    },
+  ],
+};
 ```
 
 You may eventually have a lot of documents within this Collection. If you wanted to find only documents with `color` equal to `mint`, you could write a query as follows:
 
 ```js
 const query = {
-  color: { // property name to filter on
-    equals: 'mint', // operator to use and value to compare against
+  color: {
+    // property name to filter on
+    equals: "mint", // operator to use and value to compare against
   },
-}
+};
 ```
 
 The above example demonstrates a simple query but you can get much more complex.
 
 ### Operators
 
-| Operator             | Description  |
-| -------------------- | ------------ |
-| `equals`             | The value must be exactly equal. |
-| `not_equals`         | The query will return all documents where the value is not equal. |
-| `greater_than`       | For numeric or date-based fields. |
-| `greater_than_equal` | For numeric or date-based fields. |
-| `less_than`          | For numeric or date-based fields. |
-| `less_than_equal`    | For numeric or date-based fields. |
-| `like`               | Case-insensitive string must be present. If string of words, all words must be present, in any order. |
-| `contains`           | Must contain the value entered, case-insensitive. |
-| `in`                 | The value must be found within the provided comma-delimited list of values. |
-| `not_in`             | The value must NOT be within the provided comma-delimited list of values. |
-| `exists`             | Only return documents where the value either exists (`true`) or does not exist (`false`). |
+| Operator             | Description                                                                                                                                                                       |
+| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `equals`             | The value must be exactly equal.                                                                                                                                                  |
+| `not_equals`         | The query will return all documents where the value is not equal.                                                                                                                 |
+| `greater_than`       | For numeric or date-based fields.                                                                                                                                                 |
+| `greater_than_equal` | For numeric or date-based fields.                                                                                                                                                 |
+| `less_than`          | For numeric or date-based fields.                                                                                                                                                 |
+| `less_than_equal`    | For numeric or date-based fields.                                                                                                                                                 |
+| `like`               | Case-insensitive string must be present. If string of words, all words must be present, in any order.                                                                             |
+| `contains`           | Must contain the value entered, case-insensitive.                                                                                                                                 |
+| `in`                 | The value must be found within the provided comma-delimited list of values.                                                                                                       |
+| `not_in`             | The value must NOT be within the provided comma-delimited list of values.                                                                                                         |
+| `all`                | The value must contain all values provided in the comma-delimited list.                                                                                                           |
+| `exists`             | Only return documents where the value either exists (`true`) or does not exist (`false`).                                                                                         |
 | `near`               | For distance related to a [point field](/docs/fields/point) comma separated as `<longitude>, <latitude>, <maxDistance in meters (nullable)>, <minDistance in meters (nullable)>`. |
 
 <Banner type="success">
@@ -75,36 +73,51 @@ The above example demonstrates a simple query but you can get much more complex.
 
 ### And / Or Logic
 
-In addition to defining simple queries, you can join multiple queries together using simple AND / OR logic. Let's take the above `Post` collection for example and write a more complex query usnig AND / OR:
+In addition to defining simple queries, you can join multiple queries together using simple AND / OR logic. Let's take the above `Post` collection for example and write a more complex query using AND / OR:
 
 ```js
 const query = {
-  or: [ // array of OR conditions
+  or: [
+    // array of OR conditions
     {
       color: {
-        equals: 'mint',
+        equals: "mint",
       },
     },
     {
-      and: [ // nested array of AND conditions
+      and: [
+        // nested array of AND conditions
         {
           color: {
-            equals: 'white',
-          }
+            equals: "white",
+          },
         },
         {
           featured: {
             equals: false,
-          }
-        }
-      ]
-    }
-  ]
-}
+          },
+        },
+      ],
+    },
+  ],
+};
 ```
 
 Written in plain English, if the above query were passed to a `find` operation, it would translate to finding posts where either the `color` is `mint` OR the `color` is `white` AND `featured` is set to false.
 
+### Nested properties
+
+When working with nested properties, which can happen when using relational fields, it is possible to use the dot notation to access the nested property. For example, when working with a `Song` collection that has a `artists` field which is related to an `Artists` collection using the `name: 'artists'`. You can access a property within the collection `Artists` like so:
+
+```js
+const query = {
+  "artists.featured": {
+    // nested property name to filter on
+    exists: true, // operator to use and boolean value that needs to be true
+  },
+};
+```
+
 ### GraphQL Find Queries
 
 All GraphQL `find` queries support the `where` argument, which accepts queries exactly as detailed above.
@@ -135,24 +148,29 @@ This one isn't too bad, but more complex queries get unavoidably more difficult
 **For example, using fetch:**
 
 ```js
-import qs from 'qs';
+import qs from "qs";
 
 const query = {
   color: {
-    equals: 'mint',
+    equals: "mint",
   },
   // This query could be much more complex
   // and QS would handle it beautifully
-}
+};
 
 const getPosts = async () => {
-  const stringifiedQuery = qs.stringify({
-    where: query // ensure that `qs` adds the `where` property, too!
-  }, { addQueryPrefix: true });
+  const stringifiedQuery = qs.stringify(
+    {
+      where: query, // ensure that `qs` adds the `where` property, too!
+    },
+    { addQueryPrefix: true }
+  );
 
-  const response = await fetch(`http://localhost:3000/api/posts${stringifiedQuery}`);
+  const response = await fetch(
+    `http://localhost:3000/api/posts${stringifiedQuery}`
+  );
   // Continue to handle the response below...
-}
+};
 ```
 
 ### Local API Queries
@@ -162,19 +180,18 @@ The Local API's `find` operation accepts an object exactly how you write it. For
 ```js
 const getPosts = async () => {
   const posts = await payload.find({
-    collection: 'posts',
+    collection: "posts",
     where: {
       color: {
-        equals: 'mint',
+        equals: "mint",
       },
     },
   });
 
   return posts;
-}
+};
 ```
 
-
 ## Sort
 
 Payload `find` queries support a `sort` parameter through all APIs. Pass the `name` of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
@@ -183,6 +200,7 @@ Payload `find` queries support a `sort` parameter through all APIs. Pass the `na
 **`https://localhost:3000/api/posts?sort=-createdAt`**
 
 **GraphQL example:**
+
 ```
 query {
   Posts(sort: "-createdAt") {
@@ -198,10 +216,10 @@ query {
 ```js
 const getPosts = async () => {
   const posts = await payload.find({
-    collection: 'posts',
-    sort: '-createdAt',
+    collection: "posts",
+    sort: "-createdAt",
   });
 
   return posts;
-}
+};
 ```

docs/rest-api/overview.mdx

@@ -7,7 +7,8 @@ keywords: rest, api, documentation, Content Management System, cms, headless, ja
 ---
 
 <Banner>
-  A fully functional REST API is automatically generated from your Collection and Global configs.
+  A fully functional REST API is automatically generated from your Collection
+  and Global configs.
 </Banner>
 
 All Payload API routes are mounted prefixed to your config's `routes.api` URL segment (default: `/api`).
@@ -26,56 +27,534 @@ Note: Collection slugs must be formatted in kebab-case
 
 **All CRUD operations are exposed as follows:**
 
-| Method   | Path                        | Description                            |
-| -------- | --------------------------- | -------------------------------------- |
-| `GET`    | `/api/{collection-slug}`     | Find paginated documents               |
-| `GET`    | `/api/{collection-slug}/:id` | Find a specific document by ID         |
-| `POST`   | `/api/{collection-slug}`     | Create a new document                  |
-| `PATCH`  | `/api/{collection-slug}/:id` | Update a document by ID                |
-| `DELETE` | `/api/{collection-slug}/:id` | Delete an existing document by ID      |
+<RestExamples
+  data={[
+    {
+      operation: "Find",
+      method: "GET",
+      path: "/api/{collection-slug}",
+      description: "Find paginated documents",
+      example: {
+        slug: "getCollection",
+        req: true,
+        res: {
+          paginated: true,
+          data: {
+            id: "644a5c24cc1383022535fc7c",
+            title: "Home",
+            content: "REST API examples",
+            slug: "home",
+            createdAt: "2023-04-27T11:27:32.419Z",
+            updatedAt: "2023-04-27T11:27:32.419Z",
+          },
+        },
+        drawerContent: (
+          <>
+            <h6>Additional <code>find</code> query parameters</h6>
+            The <code>find</code> endpoint supports the following additional query parameters:
+            <ul>
+              <li>
+                <a href="/docs/queries/overview#sort">sort</a> - sort by field
+              </li>
+              <li>
+                <a href="/docs/queries/overview">where</a> - pass a where query to constrain returned
+                documents
+              </li>
+              <li>
+                <a href="/docs/queries/pagination#pagination-controls">limit</a> - limit the returned
+                documents to a certain number
+              </li>
+              <li>
+                <a href="/docs/queries/pagination#pagination-controls">page</a> - get a specific page of
+                documents
+              </li>
+            </ul>
+          </>
+        ),
+      },
+    },
+    {
+      operation: "Find By ID",
+      method: "GET",
+      path: "/api/{collection-slug}/{id}",
+      description: "Find a specific document by ID",
+      example: {
+        slug: "findByID",
+        req: true,
+        res: {
+          id: "644a5c24cc1383022535fc7c",
+          title: "Home",
+          content: "REST API examples",
+          slug: "home",
+          createdAt: "2023-04-27T11:27:32.419Z",
+          updatedAt: "2023-04-27T11:27:32.419Z",
+        },
+      },
+    },
+    {
+      operation: "Create",
+      method: "POST",
+      path: "/api/{collection-slug}",
+      description: "Create a new document",
+      example: {
+        slug: "createDocument",
+        req: {
+          credentials: true,
+          headers: true,
+          body: {
+            title: "New page",
+            content: "Here is some content",
+          },
+        },
+        res: {
+          message: "Page successfully created.",
+          doc: {
+            id: "644ba34c86359864f9535932",
+            title: "New page",
+            content: "Here is some content",
+            slug: "new-page",
+            createdAt: "2023-04-28T10:43:24.466Z",
+            updatedAt: "2023-04-28T10:43:24.466Z",
+          },
+        },
+      },
+    },
+    {
+      operation: "Update",
+      method: "PATCH",
+      path: "/api/{collection-slug}",
+      description: "Update all documents matching the where query",
+      example: {
+        slug: "updateDocument",
+        req: {
+          credentials: true,
+          query: true,
+          headers: true,
+          body: {
+            title: "I have been updated!",
+          },
+        },
+        res: {
+          docs: [
+            {
+              id: "644ba34c86359864f9535932",
+              title: "I have been updated!",
+              content: "Here is some content",
+              slug: "new-page",
+              createdAt: "2023-04-28T10:43:24.466Z",
+              updatedAt: "2023-04-28T10:45:23.724Z",
+            },
+          ],
+          errors: [],
+        },
+      },
+    },
+    {
+      operation: "Update By ID",
+      method: "PATCH",
+      path: "/api/{collection-slug}/{id}",
+      description: "Update a document by ID",
+      example: {
+        slug: "updateDocumentByID",
+        req: {
+          credentials: true,
+          headers: true,
+          body: {
+            title: "I have been updated by ID!",
+            categories: "example-uuid",
+            tags: {
+              relationTo: "location",
+              value: "another-example-uuid",
+            },
+          },
+        },
+        res: {
+          message: "Updated successfully.",
+          doc: {
+            id: "644a5c24cc1383022535fc7c",
+            title: "I have been updated by ID!",
+            content: "REST API examples",
+            categories: {
+              id: "example-uuid",
+              name: "Test Category",
+            },
+            tags: [
+              {
+                relationTo: "location",
+                value: {
+                  id: "another-example-uuid",
+                  name: "Test Location",
+                },
+              },
+            ],
+            slug: "home",
+            createdAt: "2023-04-27T11:27:32.419Z",
+            updatedAt: "2023-04-28T10:47:59.259Z",
+          },
+        },
+      },
+    },
+    {
+      operation: "Delete",
+      method: "DELETE",
+      path: "/api/{collection-slug}",
+      description: "Delete all documents matching the where query",
+      example: {
+        slug: "deleteDocuments",
+        req: {
+          credentials: true,
+          query: true,
+          headers: true,
+        },
+        res: {
+          docs: [
+            {
+              id: "644ba4cf86359864f953594b",
+              title: "New page",
+              content: "Here is some content",
+              slug: "new-page",
+              createdAt: "2023-04-28T10:49:51.359Z",
+              updatedAt: "2023-04-28T10:49:51.359Z",
+            },
+          ],
+          errors: [],
+        },
+      },
+    },
+    {
+      operation: "Delete by ID",
+      method: "DELETE",
+      path: "/api/{collection-slug}/{id}",
+      description: "Delete an existing document by ID",
+      example: {
+        slug: "deleteByID",
+        req: {
+          credentials: true,
+          headers: true,
+        },
+        res: {
+          id: "644ba51786359864f9535954",
+          title: "New page",
+          content: "Here is some content",
+          slug: "new-page",
+          createdAt: "2023-04-28T10:51:03.028Z",
+          updatedAt: "2023-04-28T10:51:03.028Z",
+        },
+      },
+    },
 
-##### Additional `find` query parameters
-
-The `find` endpoint supports the following additional query parameters:
-
-- [sort](/docs/queries/overview#sort) - sort by field
-- [where](/docs/queries/overview) - pass a `where` query to constrain returned documents
-- [limit](/docs/queries/pagination#pagination-controls) - limit the returned documents to a certain number
-- [page](/docs/queries/pagination#pagination-controls) - get a specific page of documents
+]}
+/>
 
 ## Auth Operations
 
 Auth enabled collections are also given the following endpoints:
 
-| Method   | Path                        | Description |
-| -------- | --------------------------- | ----------- |
-| `POST`   | `/api/{collection-slug}/verify/:token`   | [Email verification](/docs/authentication/operations#verify-by-email), if enabled. |
-| `POST`   | `/api/{collection-slug}/unlock`          | [Unlock a user's account](/docs/authentication/operations#unlock), if enabled. |
-| `POST`   | `/api/{collection-slug}/login`           | [Logs in](/docs/authentication/operations#login) a user with email / password. |
-| `POST`   | `/api/{collection-slug}/logout`          | [Logs out](/docs/authentication/operations#logout) a user. |
-| `POST`   | `/api/{collection-slug}/refresh-token`   | [Refreshes a token](/docs/authentication/operations#refresh) that has not yet expired. |
-| `GET`    | `/api/{collection-slug}/me`              | [Returns the currently logged in user with token](/docs/authentication/operations#me). |
-| `POST`   | `/api/{collection-slug}/forgot-password` | [Password reset workflow](/docs/authentication/operations#forgot-password) entry point. |
-| `POST`   | `/api/{collection-slug}/reset-password`  | [To reset the user's password](/docs/authentication/operations#reset-password). |
+<RestExamples
+  data={[
+    {
+      operation: "Login",
+      method: "POST",
+      path: "/api/{user-collection}/login",
+      description: "Logs in a user with email / password",
+      example: {
+        slug: "login",
+        req: {
+          credentials: true,
+          headers: true,
+          body: {
+            email: "dev@payloadcms.com",
+            password: "password",
+          },
+        },
+        res: {
+          message: "Auth Passed",
+          user: {
+            id: "644b8453cd20c7857da5a9b0",
+            email: "dev@payloadcms.com",
+            _verified: true,
+            createdAt: "2023-04-28T08:31:15.788Z",
+            updatedAt: "2023-04-28T11:11:03.716Z",
+          },
+          token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+          exp: 1682689147,
+        },
+      },
+    },
+    {
+      operation: "Logout",
+      method: "POST",
+      path: "/api/{user-collection}/logout",
+      description: "Logs out a user",
+      example: {
+        slug: "logout",
+        req: {
+          headers: true,
+          credentials: true,
+        },
+        res: {
+          message: "You have been logged out successfully.",
+        },
+      },
+    },
+    {
+      operation: "Unlock",
+      method: "POST",
+      path: "/api/{user-collection}/unlock",
+      description: "Unlock a user account",
+      example: {
+        slug: "unlockCollection",
+        req: {
+          credentials: true,
+          headers: true,
+          body: {
+            email: "dev@payloadcms.com",
+          },
+        },
+        res: {
+          message: "Success",
+        },
+      },
+    },
+    {
+      operation: "Refresh",
+      method: "POST",
+      path: "/api/{user-collection}/refresh-token",
+      description: "Refreshes a token that has not yet expired",
+      example: {
+        slug: "refreshToken",
+        req: {
+          credentials: true,
+          headers: true,
+        },
+        res: {
+          message: "Token refresh successful",
+          refreshedToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+          exp: 1682689362,
+          user: {
+            email: "dev@payloadcms.com",
+            id: "644b8453cd20c7857da5a9b0",
+            collection: "users",
+          },
+        },
+      },
+    },
+    {
+      operation: "Verify User",
+      method: "POST",
+      path: "/api/{user-collection}/verify/{token}",
+      description: "User verification",
+      example: {
+        slug: "verifyUser",
+        req: {
+          credentials: true,
+          headers: true,
+        },
+        res: {
+          message: "Email verified successfully.",
+        },
+      },
+    },
+    {
+      operation: "Current User",
+      method: "GET",
+      path: "/api/{user-collection}/me",
+      description: "Returns the currently logged in user with token",
+      example: {
+        slug: "currentUser",
+        req: {
+          credentials: true,
+          headers: true,
+        },
+        res: {
+          user: {
+            id: "644b8453cd20c7857da5a9b0",
+            email: "dev@payloadcms.com",
+            _verified: true,
+            createdAt: "2023-04-28T08:31:15.788Z",
+            updatedAt: "2023-04-28T11:45:23.926Z",
+            _strategy: "local-jwt",
+          },
+          collection: "users",
+          token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+          exp: 1682689523,
+        },
+      },
+    },
+    {
+      operation: "Forgot Password",
+      method: "POST",
+      path: "/api/{user-collection}/forgot-password",
+      description: "Password reset workflow entry point",
+      example: {
+        slug: "forgotPassword",
+        req: {
+          headers: true,
+          credentials: true,
+          body: {
+            email: "dev@payloadcms.com",
+          },
+        },
+        res: {
+          message: "Success",
+        },
+      },
+    },
+    {
+      operation: "Reset Password",
+      method: "POST",
+      path: "/api/{user-collection}/reset-password",
+      description: "Reset user password",
+      example: {
+        slug: "resetPassword",
+        req: {
+          credentials: true,
+          headers: true,
+          body: {
+            token: "7eac3830ffcfc7f9f66c00315dabeb11575dba91",
+            password: "newPassword",
+          },
+        },
+        res: {
+          message: "Password reset successfully.",
+          token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+          user: {
+            id: "644baa473ea9538765cc30fc",
+            email: "dev@payloadcms.com",
+            _verified: true,
+            createdAt: "2023-04-28T11:13:11.569Z",
+            updatedAt: "2023-04-28T11:49:23.860Z",
+          },
+        },
+      },
+    },
+
+]}
+/>
 
 ## Globals
 
 Globals cannot be created or deleted, so there are only two REST endpoints opened:
 
-| Method   | Path                        | Description             |
-| -------- | --------------------------- | ----------------------- |
-| `GET`    | `/api/globals/{globalSlug}` | Get a global by slug    |
-| `POST`   | `/api/globals/{globalSlug}` | Update a global by slug |
+<RestExamples
+  data={[
+    {
+      operation: "Get Global",
+      method: "GET",
+      path: "/api/globals/{global-slug}",
+      description: "Get a global by slug",
+      example: {
+        slug: "getGlobal",
+        req: {
+          credentials: true,
+          headers: true,
+        },
+        res: {
+          announcement: "Here is an announcement!",
+          globalType: "announcement",
+          createdAt: "2023-04-28T08:53:56.066Z",
+          updatedAt: "2023-04-28T08:53:56.066Z",
+          id: "644b89a496c64a833fe579c9",
+        },
+      },
+    },
+    {
+      operation: "Update Global",
+      method: "POST",
+      path: "/api/globals/{global-slug}",
+      description: "Update a global by slug",
+      example: {
+        slug: "updateGlobal",
+        req: {
+          headers: true,
+          credentials: true,
+          body: {
+            announcement: "Paging Doctor Scrunt",
+          },
+        },
+        res: {
+          announcement: "Paging Doctor Scrunt",
+          globalType: "announcement",
+          createdAt: "2023-04-28T08:53:56.066Z",
+          updatedAt: "2023-04-28T08:53:56.066Z",
+          id: "644b89a496c64a833fe579c9",
+        },
+      },
+    },
+  ]}
+/>
 
 ## Preferences
 
 In addition to the dynamically generated endpoints above Payload also has REST endpoints to manage the admin user [preferences](/docs/admin/overview#preferences) for data specific to the authenticated user.
 
-| Method   | Path                        | Description             |
-| -------- | --------------------------- | ----------------------- |
-| `GET`    | `/api/_preferences/{key}` | Get a preference by key   |
-| `POST`   | `/api/_preferences/{key}` | Create or update by key   |
-| `DELETE` | `/api/_preferences/{key}` | Delete a user preference by key |
+<RestExamples
+  data={[
+    {
+      operation: "Get Preference",
+      method: "GET",
+      path: "/api/_preferences/{key}",
+      description: "Get a preference by key",
+      example: {
+        slug: "getPreference",
+        req: {
+          headers: true,
+          credentials: true,
+        },
+        res: {
+          _id: "644bb7a8307b3d363c6edf2c",
+          key: "region",
+          user: "644b8453cd20c7857da5a9b0",
+          userCollection: "users",
+          __v: 0,
+          createdAt: "2023-04-28T12:10:16.689Z",
+          updatedAt: "2023-04-28T12:10:16.689Z",
+          value: "Europe/London",
+        },
+      },
+    },
+    {
+      operation: "Create Preference",
+      method: "POST",
+      path: "/api/_preferences/{key}",
+      description: "Create or update a preference by key",
+      example: {
+        slug: "createPreference",
+        req: {
+          headers: true,
+          credentials: true,
+          body: {
+            value: "Europe/London",
+          },
+        },
+        res: {
+          message: "Updated successfully.",
+          doc: {
+            user: "644b8453cd20c7857da5a9b0",
+            key: "region",
+            userCollection: "users",
+            value: "Europe/London",
+          },
+        },
+      },
+    },
+    {
+      operation: "Delete Preference",
+      method: "DELETE",
+      path: "/api/_preferences/{key}",
+      description: "Delete a preference by key",
+      example: {
+        slug: "deletePreference",
+        req: {
+          headers: true,
+        },
+        res: {
+          message: "deletedSuccessfully",
+        },
+      },
+    },
+  ]}
+/>
 
 ## Custom Endpoints
 
@@ -83,42 +562,48 @@ Additional REST API endpoints can be added to your application by providing an a
 
 Each endpoint object needs to have:
 
-| Property   | Description                               |
-| ---------- | ----------------------------------------- |
-| **`path`**     | A string for the endpoint route after the collection or globals slug |
-| **`method`**   | The lowercase HTTP verb to use: 'get', 'head', 'post', 'put', 'delete', 'connect' or 'options' |
-| **`handler`**  | A function or array of functions to be called with **req**, **res** and **next** arguments. [Express](https://expressjs.com/en/guide/routing.html#route-handlers) |
-| **`root`**     | When `true`, defines the endpoint on the root Express app, bypassing Payload handlers and the `routes.api` subpath. Note: this only applies to top-level endpoints of your Payload config, endpoints defined on `collections` or `globals` cannot be root. |
+| Property      | Description                                                                                                                                                                                                                                                |
+| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`path`**    | A string for the endpoint route after the collection or globals slug                                                                                                                                                                                       |
+| **`method`**  | The lowercase HTTP verb to use: 'get', 'head', 'post', 'put', 'delete', 'connect' or 'options'                                                                                                                                                             |
+| **`handler`** | A function or array of functions to be called with **req**, **res** and **next** arguments. [Express](https://expressjs.com/en/guide/routing.html#route-handlers)                                                                                          |
+| **`root`**    | When `true`, defines the endpoint on the root Express app, bypassing Payload handlers and the `routes.api` subpath. Note: this only applies to top-level endpoints of your Payload config, endpoints defined on `collections` or `globals` cannot be root. |
+| **`custom`**  | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                  |
 
 Example:
 
 ```ts
-import { CollectionConfig } from 'payload/types';
+import { CollectionConfig } from "payload/types";
 
 // a collection of 'orders' with an additional route for tracking details, reachable at /api/orders/:id/tracking
-const Orders: CollectionConfig = {
-	slug: 'orders',
-	fields: [ /* ... */ ],
+export const Orders: CollectionConfig = {
+  slug: "orders",
+  fields: [
+    /* ... */
+  ],
   // highlight-start
   endpoints: [
     {
-      path: '/:id/tracking',
-      method: 'get',
+      path: "/:id/tracking",
+      method: "get",
       handler: async (req, res, next) => {
         const tracking = await getTrackingInfo(req.params.id);
         if (tracking) {
           res.status(200).send({ tracking });
         } else {
-          res.status(404).send({ error: 'not found' });
+          res.status(404).send({ error: "not found" });
         }
-      }
-    }
+      },
+    },
   ],
   // highlight-end
-}
+};
 ```
 
 <Banner>
-  <strong>Note:</strong><br/>
-  **req** will have the **payload** object and can be used inside your endpoint handlers for making calls like req.payload.find() that will make use of access control and hooks.
+  <strong>Note:</strong>
+  <br />
+  **req** will have the **payload** object and can be used inside your endpoint
+  handlers for making calls like req.payload.find() that will make use of access
+  control and hooks.
 </Banner>

docs/troubleshooting/troubleshooting.mdx

@@ -0,0 +1,25 @@
+---
+title: Troubleshooting
+label: Troubleshooting
+order: 10
+desc: Troubleshooting Common Issues in Payload
+keywords: admin, components, custom, customize, documentation, Content Management System, cms, headless, javascript, node, react, express, troubleshooting
+---
+
+## Common Issues
+
+### "Unauthorized, you must be logged in to make this request" when attempting to log in
+
+This means that your auth cookie is not being set or accepted correctly upon logging in. To resolve heck the following settings in your Payload config:
+
+- CORS - If you are using the '*', try to explicitly only allow certain domains instead including the one you have specified.
+- CSRF - Do you have this set? if so, make sure your domain is whitelisted within the csrf domains. If not, probably not the issue, but probably can't hurt to whitelist it anyway.
+- Cookie settings. If these are completely undefined, then that's fine. but if you have cookie domain set, or anything similar, make sure you don't have the domain misconfigured
+
+This error likely means that the auth cookie that Payload sets after logging in successfully is being rejected because of misconfiguration.
+
+To further investigate the issue:
+
+- Go to the login screen. Open your inspector. Go to the Network tab.
+- Log in and then find the login request that should appear in your network panel. Click the login request.
+- The login request should have a Set-Cookie header on the response, and the cookie should be getting set successfully. If it is not, most browsers generally have a little yellow ⚠️ symbol that you can hover over to see why the cookie was rejected.

docs/typescript/generating-types.mdx

@@ -8,7 +8,9 @@ keywords: headless cms, typescript, documentation, Content Management System, cm
 
 While building your own custom functionality into Payload, like plugins, hooks, access control functions, custom routes, GraphQL queries / mutations, or anything else, you may benefit from generating your own TypeScript types dynamically from your Payload config itself.
 
-Run the following command in a Payload project to generate types:
+### Types generatation script
+
+Run the following command in a Payload project to generate types based on your Payload config:
 
 ```
 payload generate:types
@@ -16,6 +18,46 @@ payload generate:types
 
 You can run this command whenever you need to regenerate your types, and then you can use these types in your Payload code directly.
 
+### Configuration
+
+In order for Payload to properly infer these types when using local operations, you'll need to alias the following in your tsconfig.json file:
+
+```json
+// tsconfig.json
+
+{
+  "compilerOptions": {
+    // ...
+    "paths": {
+      "payload/generated-types": [
+        "./src/payload-types.ts" // Ensure this matches the path to your typescript outputFile
+      ]
+    }
+  }
+  // ...
+}
+```
+
+#### Custom output file path
+
+You can specify where you want your types to be generated by adding a property to your Payload config:
+
+```ts
+// payload.config.ts
+
+{
+  // ...
+	typescript: {
+    // defaults to: path.resolve(__dirname, './payload-types.ts')
+		outputFile: path.resolve(__dirname, './generated-types.ts'),
+	},
+}
+```
+
+The above example places your types next to your Payload config itself as the file `generated-types.ts`.
+
+### Example Usage
+
 For example, let's look at the following simple Payload config:
 
 ```ts
@@ -74,28 +116,65 @@ export interface Post {
   title?: string;
   author?: string | User;
 }
-
 ```
 
-#### Customizing the output path of your generated types
+### Custom Field Interfaces
 
-You can specify where you want your types to be generated by adding a property to your Payload config:
+For `array`, `block`, `group` and named `tab` fields, you can generate top level reusable interfaces. The following group field config:
 
-```
+```ts
 {
-  // the remainder of your config
-	typescript: {
-		outputFile: path.resolve(__dirname, './generated-types.ts'),
-	},
+  type: 'group',
+  name: 'meta',
+  interfaceName: 'SharedMeta', <-- here!!
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+    },
+    {
+      name: 'description',
+      type: 'text',
+    },
+  ],
 }
 ```
 
-The above example places your types next to your Payload config itself as the file `generated-types.ts`. By default, the file will be output to your current working directory as `payload-types.ts`.
+will generate:
+
+```ts
+// a top level reusable interface!!
+export interface SharedMeta {
+  title?: string;
+  description?: string;
+}
+
+// example usage inside collection interface
+export interface Collection1 {
+  // ...other fields
+  meta?: SharedMeta;
+}
+```
+
+<Banner type="warning">
+  <strong>Naming Collisions</strong>
+  <br />
+  Since these types are hoisted to the top level, you need to be aware that
+  naming collisions can occur. For example, if you have a collection with the
+  name of `Meta` and you also create a interface with the name `Meta` they will
+  collide. It is recommended to scope your interfaces by appending the field
+  type to the end, i.e. `MetaGroup` or similar.
+</Banner>
+
+### Using your types
+
+Now that your types have been generated, payloads local API will now be typed. It is common for users to want to use this in their frontend code, we recommend generating them with payload and then copying the file over to your frontend codebase. This is the simplest way to get your types into your frontend codebase.
 
 #### Adding an NPM script
 
 <Banner type="warning">
-  <strong>Important:</strong><br/>
+  <strong>Important</strong>
+  <br />
   Payload needs to be able to find your config to generate your types.
 </Banner>
 

docs/upload/overview.mdx

@@ -42,7 +42,7 @@ Every Payload Collection can opt-in to supporting Uploads by specifying the `upl
 
 | Option                    | Description                                                                                                                                     |
 | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`staticURL`** \*        | The base URL path to use to access your uploads. Example: `/media`                                                                              |
+| **`staticURL`** \*        | The URL path to use to access your uploads. Relative path like `/media` will be served by payload. Full path like `https://example.com/media` needs to be served by another web server. |
 | **`staticDir`** \*        | The folder directory to use to store media in. Can be either an absolute path or relative to the directory that contains your config.           |
 | **`imageSizes`**          | If specified, image uploads will be automatically resized in accordance to these image sizes. [More](#image-sizes)                              |
 | **`formatOptions`**       | An object with `format` and `options` that are used with the Sharp image library to format the upload file. [More](https://sharp.pixelplumbing.com/api-output#toformat) |
@@ -60,7 +60,7 @@ _An asterisk denotes that a property above is required._
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Media: CollectionConfig = {
+export const Media: CollectionConfig = {
   slug: 'media',
   upload: {
     staticURL: '/media',
@@ -81,17 +81,23 @@ const Media: CollectionConfig = {
       {
         name: 'tablet',
         width: 1024,
-        // By specifying `null` or leaving a height undefined,
+        // By specifying `undefined` or leaving a height undefined,
         // the image will be sized to a certain width,
         // but it will retain its original aspect ratio
         // and calculate a height automatically.
-        height: null,
+        height: undefined,
         position: 'centre',
       },
     ],
     adminThumbnail: 'thumbnail',
     mimeTypes: ['image/*'],
   },
+  fields: [
+    {
+      name: 'alt',
+      type: 'text',
+    },
+  ],
 };
 ```
 
@@ -165,7 +171,7 @@ You can specify how Payload retrieves admin thumbnails for your upload-enabled C
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Media: CollectionConfig = {
+export const Media: CollectionConfig = {
   slug: 'media',
   upload: {
     staticURL: '/media',
@@ -200,7 +206,7 @@ Some example values are: `image/*`, `audio/*`, `video/*`, `image/png`, `applicat
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Media: CollectionConfig = {
+export const Media: CollectionConfig = {
   slug: 'media',
   upload: {
     staticURL: '/media',

docs/versions/autosave.mdx

@@ -28,7 +28,7 @@ Collections and Globals both support the same options for configuring autosave.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Pages: CollectionConfig = {
+export const Pages: CollectionConfig = {
   slug: 'pages',
   access: {
     read: ({ req }) => {

docs/versions/drafts.mdx

@@ -84,7 +84,7 @@ Here is an example that utilizes the `_status` field to require a user to be log
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Pages: CollectionConfig = {
+export const Pages: CollectionConfig = {
   slug: 'pages',
   access: {
     read: ({ req }) => {
@@ -119,7 +119,7 @@ Here is an example for how to write an access control function that grants acces
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Pages: CollectionConfig = {
+export const Pages: CollectionConfig = {
   slug: 'pages',
   access: {
     read: ({ req }) => {

docs/versions/overview.mdx

@@ -7,13 +7,14 @@ keywords: version history, revisions, audit log, draft, publish, restore, autosa
 ---
 
 <Banner>
-  Payload's powerful Versions functionality allows you to keep a running history of changes over time and extensible to fit any content publishing workflow.
+  Payload's powerful Versions functionality allows you to keep a running history
+  of changes over time and extensible to fit any content publishing workflow.
 </Banner>
 
 When enabled, Payload will automatically scaffold a new Collection in your database to store versions of your document(s) over time, and the Admin UI will be extended with additional views that allow you to browse document versions, view diffs in order to see exactly what has changed in your documents (and when they changed), and restore documents back to prior versions easily.
 
 ![Versions](/images/docs/versions.png)
-*Comparing an old version to a newer version of a document*
+_Comparing an old version to a newer version of a document_
 
 **With Versions, you can:**
 
@@ -25,7 +26,9 @@ When enabled, Payload will automatically scaffold a new Collection in your datab
 - Build a powerful publishing schedule mechanism to create documents and have them become publicly readable automatically at a future date
 
 <Banner type="success">
-	Versions are extremely performant and totally opt-in. They don't change the shape of your data at all. All versions are stored in a separate Collection and can be turned on and off easily at your discretion.
+  Versions are extremely performant and totally opt-in. They don't change the
+  shape of your data at all. All versions are stored in a separate Collection
+  and can be turned on and off easily at your discretion.
 </Banner>
 
 ### Options
@@ -50,22 +53,19 @@ When you have versions, drafts, _and_ `autosave` enabled, the Admin UI will auto
 
 Configuring Versions is done by adding the `versions` key to your Collection configs. Set it to `true` to enable default Versions settings, or customize versions options by setting the property equal to an object containing the following available options:
 
-| Option                       | Description  |
-| ---------------------------- | -------------|
-| `maxPerDoc`                  | Use this setting to control how many versions to keep on a document by document basis. Must be an integer. |
-| `retainDeleted`              | Boolean to determine if, when a document is deleted, you'd like to retain versions of that document, or go through and automatically delete all versions that are associated with the deleted document. |
-| `drafts `                    | Enable [Drafts](/docs/versions/drafts) mode for this collection. To enable, set to `true` or pass an object with `draft` [options](/docs/versions/drafts#options). |
-
+| Option      | Description                                                                                                                                                        |
+| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `maxPerDoc` | Use this setting to control how many versions to keep on a document by document basis. Must be an integer. Defaults to 100, use 0 to save all versions.            |
+| `drafts `   | Enable [Drafts](/docs/versions/drafts) mode for this collection. To enable, set to `true` or pass an object with `draft` [options](/docs/versions/drafts#options). |
 
 ### Global config
 
 Global versions work similarly to Collection versions but have a slightly different set of config properties supported.
 
-| Option    | Description  |
-| --------- | -------------|
-| `max`     | Use this setting to control how many versions to keep on a global by global basis. Must be an integer. |
-| `drafts`  | Enable [Drafts](/docs/versions/drafts) mode for this global. To enable, set to `true` or pass an object with `draft` [options](/docs/versions/drafts#options) |
-
+| Option   | Description                                                                                                                                                   |
+| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `max`    | Use this setting to control how many versions to keep on a global by global basis. Must be an integer.                                                        |
+| `drafts` | Enable [Drafts](/docs/versions/drafts) mode for this global. To enable, set to `true` or pass an object with `draft` [options](/docs/versions/drafts#options) |
 
 #### Database impact
 
@@ -99,24 +99,24 @@ Versions expose new operations for both collections and globals. They allow you
 
 **Collection REST endpoints:**
 
-| Method   | Path                                 | Description                            |
-| -------- | ------------------------------------ | -------------------------------------- |
-| `GET`    | `/api/{collectionSlug}/versions`     | Find and query paginated versions      |
-| `GET`    | `/api/{collectionSlug}/versions/:id` | Find a specific version by ID          |
-| `POST`   | `/api/{collectionSlug}/versions/:id` | Restore a version by ID                |
+| Method | Path                                 | Description                       |
+| ------ | ------------------------------------ | --------------------------------- |
+| `GET`  | `/api/{collectionSlug}/versions`     | Find and query paginated versions |
+| `GET`  | `/api/{collectionSlug}/versions/:id` | Find a specific version by ID     |
+| `POST` | `/api/{collectionSlug}/versions/:id` | Restore a version by ID           |
 
 **Collection GraphQL queries:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`version{collection.label.singular}`**     | `findVersionByID` |
-| **`versions{collection.label.plural}`**      | `findVersions` |
+| Query Name                               | Operation         |
+| ---------------------------------------- | ----------------- |
+| **`version{collection.label.singular}`** | `findVersionByID` |
+| **`versions{collection.label.plural}`**  | `findVersions`    |
 
 **And mutation:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`restoreVersion{collection.label.singular}`**   | `restoreVersion` |
+| Query Name                                      | Operation        |
+| ----------------------------------------------- | ---------------- |
+| **`restoreVersion{collection.label.singular}`** | `restoreVersion` |
 
 **Collection Local API methods:**
 
@@ -126,18 +126,18 @@ Versions expose new operations for both collections and globals. They allow you
 // Result will be a paginated set of Versions.
 // See /docs/queries/pagination for more.
 const result = await payload.findVersions({
-  collection: 'posts', // required
+  collection: "posts", // required
   depth: 2,
   page: 1,
   limit: 10,
   where: {}, // pass a `where` query here
-  sort: '-createdAt',
-  locale: 'en',
+  sort: "-createdAt",
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 #### Find by ID
@@ -145,15 +145,15 @@ const result = await payload.findVersions({
 ```js
 // Result will be a Post document.
 const result = await payload.findVersionByID({
-  collection: 'posts', // required
-  id: '507f1f77bcf86cd799439013', // required
+  collection: "posts", // required
+  id: "507f1f77bcf86cd799439013", // required
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 #### Restore
@@ -161,35 +161,35 @@ const result = await payload.findVersionByID({
 ```js
 // Result will be the restored global document.
 const result = await payload.restoreVersion({
-  collection: 'posts', // required
-  id: '507f1f77bcf86cd799439013', // required
+  collection: "posts", // required
+  id: "507f1f77bcf86cd799439013", // required
   depth: 2,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 **Global REST endpoints:**
 
-| Method   | Path                                     | Description                            |
-| -------- | ---------------------------------------- | -------------------------------------- |
-| `GET`    | `/api/globals/{globalSlug}/versions`     | Find and query paginated versions      |
-| `GET`    | `/api/globals/{globalSlug}/versions/:id` | Find a specific version by ID          |
-| `POST`   | `/api/globals/{globalSlug}/versions/:id` | Restore a version by ID                |
+| Method | Path                                     | Description                       |
+| ------ | ---------------------------------------- | --------------------------------- |
+| `GET`  | `/api/globals/{globalSlug}/versions`     | Find and query paginated versions |
+| `GET`  | `/api/globals/{globalSlug}/versions/:id` | Find a specific version by ID     |
+| `POST` | `/api/globals/{globalSlug}/versions/:id` | Restore a version by ID           |
 
 **Global GraphQL queries:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`version{global.label}`**     | `findVersionByID` |
-| **`versions{global.label}`**    | `findVersions` |
+| Query Name                   | Operation         |
+| ---------------------------- | ----------------- |
+| **`version{global.label}`**  | `findVersionByID` |
+| **`versions{global.label}`** | `findVersions`    |
 
 **Global GraphQL mutation:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`restoreVersion{global.label}`**   | `restoreVersion` |
+| Query Name                         | Operation        |
+| ---------------------------------- | ---------------- |
+| **`restoreVersion{global.label}`** | `restoreVersion` |
 
 **Global Local API methods:**
 
@@ -199,18 +199,18 @@ const result = await payload.restoreVersion({
 // Result will be a paginated set of Versions.
 // See /docs/queries/pagination for more.
 const result = await payload.findGlobalVersions({
-  slug: 'header', // required
+  slug: "header", // required
   depth: 2,
   page: 1,
   limit: 10,
   where: {}, // pass a `where` query here
-  sort: '-createdAt',
-  locale: 'en',
+  sort: "-createdAt",
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 #### Find by ID
@@ -218,15 +218,15 @@ const result = await payload.findGlobalVersions({
 ```js
 // Result will be a Post document.
 const result = await payload.findGlobalVersionByID({
-  slug: 'header', // required
-  id: '507f1f77bcf86cd799439013', // required
+  slug: "header", // required
+  id: "507f1f77bcf86cd799439013", // required
   depth: 2,
-  locale: 'en',
+  locale: "en",
   fallbackLocale: false,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 #### Restore
@@ -234,13 +234,13 @@ const result = await payload.findGlobalVersionByID({
 ```js
 // Result will be the restored global document.
 const result = await payload.restoreGlobalVersion({
-  slug: 'header', // required
-  id: '507f1f77bcf86cd799439013', // required
+  slug: "header", // required
+  id: "507f1f77bcf86cd799439013", // required
   depth: 2,
   user: dummyUser,
   overrideAccess: false,
   showHiddenFields: true,
-})
+});
 ```
 
 ### Access Control
@@ -249,6 +249,6 @@ Versions expose a new access control function on both Collections and Globals th
 
 **New version access control:**
 
-| Function                 | Allows/Denies Access |
-| ------------------------ | -------------------- |
-| **`readVersions`**       | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. |
+| Function           | Allows/Denies Access                                                                                                   |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| **`readVersions`** | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. |

errors.js

@@ -1,6 +1,39 @@
-const { APIError, Forbidden } = require('./dist/errors');
+const {
+  APIError,
+  AuthenticationError,
+  DuplicateCollection,
+  DuplicateGlobal,
+  ErrorDeletingFile,
+  FileUploadError,
+  Forbidden,
+  InvalidConfiguration,
+  InvalidFieldName,
+  InvalidFieldRelationship,
+  LockedAuth,
+  MissingCollectionLabel,
+  MissingFieldInputOptions,
+  MissingFieldType,
+  MissingFile,
+  NotFound,
+  ValidationError,
+} = require('./dist/errors');
 
 module.exports = {
   APIError,
+  AuthenticationError,
+  DuplicateCollection,
+  DuplicateGlobal,
+  ErrorDeletingFile,
+  FileUploadError,
   Forbidden,
+  InvalidConfiguration,
+  InvalidFieldName,
+  InvalidFieldRelationship,
+  LockedAuth,
+  MissingCollectionLabel,
+  MissingFieldInputOptions,
+  MissingFieldType,
+  MissingFile,
+  NotFound,
+  ValidationError,
 };

eslint-config/configs/base/index.js

@@ -0,0 +1,17 @@
+module.exports = {
+  plugins: [
+    'node',
+  ],
+  env: {
+    node: true,
+  },
+  extends: [
+    './rules/best-practices',
+    './rules/errors',
+    './rules/es6',
+    './rules/imports',
+    './rules/style',
+    './rules/variables',
+  ].map(require.resolve),
+  rules: {},
+};

eslint-config/configs/base/rules/best-practices.js

@@ -0,0 +1,356 @@
+module.exports = {
+  rules: {
+    // enforces getter/setter pairs in objects
+    'accessor-pairs': 'off',
+
+    // enforces return statements in callbacks of array's methods
+    // https://eslint.org/docs/rules/array-callback-return
+    'array-callback-return': ['error', { allowImplicit: true }],
+
+    // treat var statements as if they were block scoped
+    'block-scoped-var': 'error',
+
+    // specify the maximum cyclomatic complexity allowed in a program
+    complexity: ['off', 11],
+
+    // enforce that class methods use "this"
+    // https://eslint.org/docs/rules/class-methods-use-this
+    'class-methods-use-this': ['error', {
+      exceptMethods: [],
+    }],
+
+    // require return statements to either always or never specify values
+    'consistent-return': 'error',
+
+    // specify curly brace conventions for all control statements
+    curly: ['error', 'multi-line'], // multiline
+
+    // require default case in switch statements
+    'default-case': ['error', { commentPattern: '^no default$' }],
+
+    // https://eslint.org/docs/rules/default-param-last
+    // TODO: enable, semver-minor, when eslint v6.4 is required (which is a major)
+    'default-param-last': 'off',
+
+    // encourages use of dot notation whenever possible
+    'dot-notation': ['error', { allowKeywords: true }],
+
+    // enforces consistent newlines before or after dots
+    // https://eslint.org/docs/rules/dot-location
+    'dot-location': ['error', 'property'],
+
+    // require the use of === and !==
+    // https://eslint.org/docs/rules/eqeqeq
+    eqeqeq: ['error', 'always', { null: 'ignore' }],
+
+    // Require grouped accessor pairs in object literals and classes
+    // https://eslint.org/docs/rules/grouped-accessor-pairs
+    // TODO: enable in next major, altho the guide forbids getters/setters anyways
+    'grouped-accessor-pairs': 'off',
+
+    // make sure for-in loops have an if statement
+    'guard-for-in': 'error',
+
+    // enforce a maximum number of classes per file
+    // https://eslint.org/docs/rules/max-classes-per-file
+    'max-classes-per-file': ['error', 1],
+
+    // disallow the use of alert, confirm, and prompt
+    'no-alert': 'warn',
+
+    // disallow use of arguments.caller or arguments.callee
+    'no-caller': 'error',
+
+    // disallow lexical declarations in case/default clauses
+    // https://eslint.org/docs/rules/no-case-declarations.html
+    'no-case-declarations': 'error',
+
+    // Disallow returning value in constructor
+    // https://eslint.org/docs/rules/no-constructor-return
+    // TODO: enable, semver-major
+    'no-constructor-return': 'off',
+
+    // disallow division operators explicitly at beginning of regular expression
+    // https://eslint.org/docs/rules/no-div-regex
+    'no-div-regex': 'off',
+
+    // disallow else after a return in an if
+    // https://eslint.org/docs/rules/no-else-return
+    'no-else-return': ['error', { allowElseIf: false }],
+
+    // disallow empty functions, except for standalone funcs/arrows
+    // https://eslint.org/docs/rules/no-empty-function
+    'no-empty-function': ['error', {
+      allow: [
+        'arrowFunctions',
+        'functions',
+        'methods',
+      ],
+    }],
+
+    // disallow empty destructuring patterns
+    // https://eslint.org/docs/rules/no-empty-pattern
+    'no-empty-pattern': 'error',
+
+    // disallow comparisons to null without a type-checking operator
+    'no-eq-null': 'off',
+
+    // disallow use of eval()
+    'no-eval': 'error',
+
+    // disallow adding to native types
+    'no-extend-native': 'error',
+
+    // disallow unnecessary function binding
+    'no-extra-bind': 'error',
+
+    // disallow Unnecessary Labels
+    // https://eslint.org/docs/rules/no-extra-label
+    'no-extra-label': 'error',
+
+    // disallow fallthrough of case statements
+    'no-fallthrough': 'error',
+
+    // disallow the use of leading or trailing decimal points in numeric literals
+    'no-floating-decimal': 'error',
+
+    // disallow reassignments of native objects or read-only globals
+    // https://eslint.org/docs/rules/no-global-assign
+    'no-global-assign': ['error', { exceptions: [] }],
+    // deprecated in favor of no-global-assign
+    'no-native-reassign': 'off',
+
+    // disallow implicit type conversions
+    // https://eslint.org/docs/rules/no-implicit-coercion
+    'no-implicit-coercion': ['off', {
+      boolean: false,
+      number: true,
+      string: true,
+      allow: [],
+    }],
+
+    // disallow var and named functions in global scope
+    // https://eslint.org/docs/rules/no-implicit-globals
+    'no-implicit-globals': 'off',
+
+    // disallow use of eval()-like methods
+    'no-implied-eval': 'error',
+
+    // disallow this keywords outside of classes or class-like objects
+    'no-invalid-this': 'off',
+
+    // disallow usage of __iterator__ property
+    'no-iterator': 'error',
+
+    // disallow use of labels for anything other then loops and switches
+    'no-labels': ['error', { allowLoop: false, allowSwitch: false }],
+
+    // disallow unnecessary nested blocks
+    'no-lone-blocks': 'error',
+
+    // disallow creation of functions within loops
+    'no-loop-func': 'error',
+
+    // disallow magic numbers
+    // https://eslint.org/docs/rules/no-magic-numbers
+    'no-magic-numbers': ['off', {
+      ignore: [],
+      ignoreArrayIndexes: true,
+      enforceConst: true,
+      detectObjects: false,
+    }],
+
+    // disallow use of multiple spaces
+    'no-multi-spaces': ['error', {
+      ignoreEOLComments: false,
+    }],
+
+    // disallow use of multiline strings
+    'no-multi-str': 'error',
+
+    // disallow use of new operator when not part of the assignment or comparison
+    'no-new': 'error',
+
+    // disallow use of new operator for Function object
+    'no-new-func': 'error',
+
+    // disallows creating new instances of String, Number, and Boolean
+    'no-new-wrappers': 'error',
+
+    // disallow use of (old style) octal literals
+    'no-octal': 'error',
+
+    // disallow use of octal escape sequences in string literals, such as
+    // var foo = 'Copyright \251';
+    'no-octal-escape': 'error',
+
+    // disallow reassignment of function parameters
+    // disallow parameter object manipulation except for specific exclusions
+    // rule: https://eslint.org/docs/rules/no-param-reassign.html
+    'no-param-reassign': ['error', {
+      props: true,
+      ignorePropertyModificationsFor: [
+        'acc', // for reduce accumulators
+        'accumulator', // for reduce accumulators
+        'e', // for e.returnvalue
+        'ctx', // for Koa routing
+        'req', // for Express requests
+        'request', // for Express requests
+        'res', // for Express responses
+        'response', // for Express responses
+        '$scope', // for Angular 1 scopes
+        'staticContext', // for ReactRouter context
+      ],
+    }],
+
+    // disallow usage of __proto__ property
+    'no-proto': 'error',
+
+    // disallow declaring the same variable more then once
+    'no-redeclare': 'error',
+
+    // disallow certain object properties
+    // https://eslint.org/docs/rules/no-restricted-properties
+    'no-restricted-properties': ['error',
+      {
+        object: 'arguments',
+        property: 'callee',
+        message: 'arguments.callee is deprecated',
+      }, {
+        object: 'global',
+        property: 'isFinite',
+        message: 'Please use Number.isFinite instead',
+      }, {
+        object: 'self',
+        property: 'isFinite',
+        message: 'Please use Number.isFinite instead',
+      }, {
+        object: 'window',
+        property: 'isFinite',
+        message: 'Please use Number.isFinite instead',
+      }, {
+        object: 'global',
+        property: 'isNaN',
+        message: 'Please use Number.isNaN instead',
+      }, {
+        object: 'self',
+        property: 'isNaN',
+        message: 'Please use Number.isNaN instead',
+      }, {
+        object: 'window',
+        property: 'isNaN',
+        message: 'Please use Number.isNaN instead',
+      }, {
+        property: '__defineGetter__',
+        message: 'Please use Object.defineProperty instead.',
+      }, {
+        property: '__defineSetter__',
+        message: 'Please use Object.defineProperty instead.',
+      }, {
+        object: 'Math',
+        property: 'pow',
+        message: 'Use the exponentiation operator (**) instead.',
+      }],
+
+    // disallow use of assignment in return statement
+    'no-return-assign': ['error', 'always'],
+
+    // disallow redundant `return await`
+    'no-return-await': 'error',
+
+    // disallow use of `javascript:` urls.
+    'no-script-url': 'error',
+
+    // disallow self assignment
+    // https://eslint.org/docs/rules/no-self-assign
+    'no-self-assign': ['error', {
+      props: true,
+    }],
+
+    // disallow comparisons where both sides are exactly the same
+    'no-self-compare': 'error',
+
+    // disallow use of comma operator
+    'no-sequences': 'error',
+
+    // restrict what can be thrown as an exception
+    'no-throw-literal': 'error',
+
+    // disallow unmodified conditions of loops
+    // https://eslint.org/docs/rules/no-unmodified-loop-condition
+    'no-unmodified-loop-condition': 'off',
+
+    // disallow usage of expressions in statement position
+    'no-unused-expressions': ['error', {
+      allowShortCircuit: false,
+      allowTernary: false,
+      allowTaggedTemplates: false,
+    }],
+
+    // disallow unused labels
+    // https://eslint.org/docs/rules/no-unused-labels
+    'no-unused-labels': 'error',
+
+    // disallow unnecessary .call() and .apply()
+    'no-useless-call': 'off',
+
+    // Disallow unnecessary catch clauses
+    // https://eslint.org/docs/rules/no-useless-catch
+    'no-useless-catch': 'error',
+
+    // disallow useless string concatenation
+    // https://eslint.org/docs/rules/no-useless-concat
+    'no-useless-concat': 'error',
+
+    // disallow unnecessary string escaping
+    // https://eslint.org/docs/rules/no-useless-escape
+    'no-useless-escape': 'error',
+
+    // disallow redundant return; keywords
+    // https://eslint.org/docs/rules/no-useless-return
+    'no-useless-return': 'error',
+
+    // disallow use of void operator
+    // https://eslint.org/docs/rules/no-void
+    'no-void': 'error',
+
+    // disallow usage of configurable warning terms in comments: e.g. todo
+    'no-warning-comments': ['off', { terms: ['todo', 'fixme', 'xxx'], location: 'start' }],
+
+    // disallow use of the with statement
+    'no-with': 'error',
+
+    // require using Error objects as Promise rejection reasons
+    // https://eslint.org/docs/rules/prefer-promise-reject-errors
+    'prefer-promise-reject-errors': ['error', { allowEmptyReject: true }],
+
+    // Suggest using named capture group in regular expression
+    // https://eslint.org/docs/rules/prefer-named-capture-group
+    'prefer-named-capture-group': 'off',
+
+    // https://eslint.org/docs/rules/prefer-regex-literals
+    // TODO; enable, semver-minor, once eslint v6.4 is required (which is a major)
+    'prefer-regex-literals': 'off',
+
+    // require use of the second argument for parseInt()
+    radix: 'error',
+
+    // require `await` in `async function` (note: this is a horrible rule that should never be used)
+    // https://eslint.org/docs/rules/require-await
+    'require-await': 'off',
+
+    // Enforce the use of u flag on RegExp
+    // https://eslint.org/docs/rules/require-unicode-regexp
+    'require-unicode-regexp': 'off',
+
+    // requires to declare all vars on top of their containing scope
+    'vars-on-top': 'error',
+
+    // require immediate function invocation to be wrapped in parentheses
+    // https://eslint.org/docs/rules/wrap-iife.html
+    'wrap-iife': ['error', 'outside', { functionPrototypeMethods: false }],
+
+    // require or disallow Yoda conditions
+    yoda: 'error',
+  },
+};

eslint-config/configs/base/rules/errors.js

@@ -0,0 +1,154 @@
+module.exports = {
+  rules: {
+    // Enforce “for” loop update clause moving the counter in the right direction
+    // https://eslint.org/docs/rules/for-direction
+    'for-direction': 'error',
+
+    // Enforces that a return statement is present in property getters
+    // https://eslint.org/docs/rules/getter-return
+    'getter-return': ['error', { allowImplicit: true }],
+
+    // disallow using an async function as a Promise executor
+    // https://eslint.org/docs/rules/no-async-promise-executor
+    'no-async-promise-executor': 'error',
+
+    // Disallow await inside of loops
+    // https://eslint.org/docs/rules/no-await-in-loop
+    'no-await-in-loop': 'error',
+
+    // Disallow comparisons to negative zero
+    // https://eslint.org/docs/rules/no-compare-neg-zero
+    'no-compare-neg-zero': 'error',
+
+    // disallow assignment in conditional expressions
+    'no-cond-assign': ['error', 'always'],
+
+    // disallow use of console
+    'no-console': ['warn', { allow: ['warn', 'error'] }],
+
+    // disallow use of constant expressions in conditions
+    'no-constant-condition': 'warn',
+
+    // disallow control characters in regular expressions
+    'no-control-regex': 'error',
+
+    // disallow use of debugger
+    'no-debugger': 'error',
+
+    // disallow duplicate arguments in functions
+    'no-dupe-args': 'error',
+
+    // Disallow duplicate conditions in if-else-if chains
+    // https://eslint.org/docs/rules/no-dupe-else-if
+    // TODO: enable, semver-major
+    'no-dupe-else-if': 'off',
+
+    // disallow duplicate keys when creating object literals
+    'no-dupe-keys': 'error',
+
+    // disallow a duplicate case label.
+    'no-duplicate-case': 'error',
+
+    // disallow empty statements
+    'no-empty': 'error',
+
+    // disallow the use of empty character classes in regular expressions
+    'no-empty-character-class': 'error',
+
+    // disallow assigning to the exception in a catch block
+    'no-ex-assign': 'error',
+
+    // disallow double-negation boolean casts in a boolean context
+    // https://eslint.org/docs/rules/no-extra-boolean-cast
+    'no-extra-boolean-cast': 'error',
+
+    // disallow unnecessary parentheses
+    // https://eslint.org/docs/rules/no-extra-parens
+    'no-extra-parens': ['off', 'all', {
+      conditionalAssign: true,
+      nestedBinaryExpressions: false,
+      returnAssign: false,
+      ignoreJSX: 'all', // delegate to eslint-plugin-react
+      enforceForArrowConditionals: false,
+    }],
+
+    // disallow unnecessary semicolons
+    'no-extra-semi': 'error',
+
+    // disallow overwriting functions written as function declarations
+    'no-func-assign': 'error',
+
+    // https://eslint.org/docs/rules/no-import-assign
+    // TODO: enable, semver-minor, once eslint v6.4 is required (which is a major)
+    'no-import-assign': 'off',
+
+    // disallow function or variable declarations in nested blocks
+    'no-inner-declarations': 'error',
+
+    // disallow invalid regular expression strings in the RegExp constructor
+    'no-invalid-regexp': 'error',
+
+    // disallow irregular whitespace outside of strings and comments
+    'no-irregular-whitespace': 'error',
+
+    // Disallow characters which are made with multiple code points in character class syntax
+    // https://eslint.org/docs/rules/no-misleading-character-class
+    'no-misleading-character-class': 'error',
+
+    // disallow the use of object properties of the global object (Math and JSON) as functions
+    'no-obj-calls': 'error',
+
+    // disallow use of Object.prototypes builtins directly
+    // https://eslint.org/docs/rules/no-prototype-builtins
+    'no-prototype-builtins': 'error',
+
+    // disallow multiple spaces in a regular expression literal
+    'no-regex-spaces': 'error',
+
+    // Disallow returning values from setters
+    // https://eslint.org/docs/rules/no-setter-return
+    // TODO: enable, semver-major (altho the guide forbids getters/setters already)
+    'no-setter-return': 'off',
+
+    // disallow sparse arrays
+    'no-sparse-arrays': 'error',
+
+    // Disallow template literal placeholder syntax in regular strings
+    // https://eslint.org/docs/rules/no-template-curly-in-string
+    'no-template-curly-in-string': 'error',
+
+    // Avoid code that looks like two expressions but is actually one
+    // https://eslint.org/docs/rules/no-unexpected-multiline
+    'no-unexpected-multiline': 'error',
+
+    // disallow unreachable statements after a return, throw, continue, or break statement
+    'no-unreachable': 'error',
+
+    // disallow return/throw/break/continue inside finally blocks
+    // https://eslint.org/docs/rules/no-unsafe-finally
+    'no-unsafe-finally': 'error',
+
+    // disallow negating the left operand of relational operators
+    // https://eslint.org/docs/rules/no-unsafe-negation
+    'no-unsafe-negation': 'error',
+    // disallow negation of the left operand of an in expression
+    // deprecated in favor of no-unsafe-negation
+    'no-negated-in-lhs': 'off',
+
+    // Disallow assignments that can lead to race conditions due to usage of await or yield
+    // https://eslint.org/docs/rules/require-atomic-updates
+    // TODO: enable, semver-major
+    'require-atomic-updates': 'off',
+
+    // disallow comparisons with the value NaN
+    'use-isnan': 'error',
+
+    // ensure JSDoc comments are valid
+    // https://eslint.org/docs/rules/valid-jsdoc
+    'valid-jsdoc': 'off',
+
+    // ensure that the results of typeof are compared against a valid string
+    // https://eslint.org/docs/rules/valid-typeof
+    'valid-typeof': ['error', { requireStringLiterals: true }],
+  },
+};

eslint-config/configs/base/rules/es6.js

@@ -0,0 +1,176 @@
+module.exports = {
+  env: {
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+    ecmaFeatures: {
+      generators: false,
+      objectLiteralDuplicateProperties: false,
+    },
+  },
+  rules: {
+    // enforces no braces where they can be omitted
+    // https://eslint.org/docs/rules/arrow-body-style
+    'arrow-body-style': ['error', 'as-needed', {
+      requireReturnForObjectLiteral: false,
+    }],
+
+    // require parens in arrow function arguments
+    // https://eslint.org/docs/rules/arrow-parens
+    'arrow-parens': ['error', 'always'],
+
+    // require space before/after arrow function's arrow
+    // https://eslint.org/docs/rules/arrow-spacing
+    'arrow-spacing': ['error', { before: true, after: true }],
+
+    // verify super() callings in constructors
+    'constructor-super': 'error',
+
+    // enforce the spacing around the * in generator functions
+    // https://eslint.org/docs/rules/generator-star-spacing
+    'generator-star-spacing': ['error', { before: false, after: true }],
+
+    // disallow modifying variables of class declarations
+    // https://eslint.org/docs/rules/no-class-assign
+    'no-class-assign': 'error',
+
+    // disallow arrow functions where they could be confused with comparisons
+    // https://eslint.org/docs/rules/no-confusing-arrow
+    'no-confusing-arrow': ['error', {
+      allowParens: true,
+    }],
+
+    // disallow modifying variables that are declared using const
+    'no-const-assign': 'error',
+
+    // disallow duplicate class members
+    // https://eslint.org/docs/rules/no-dupe-class-members
+    'no-dupe-class-members': 'error',
+
+    // disallow importing from the same path more than once
+    // https://eslint.org/docs/rules/no-duplicate-imports
+    // replaced by https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md
+    'no-duplicate-imports': 'off',
+
+    // disallow symbol constructor
+    // https://eslint.org/docs/rules/no-new-symbol
+    'no-new-symbol': 'error',
+
+    // disallow specific imports
+    // https://eslint.org/docs/rules/no-restricted-imports
+    'no-restricted-imports': ['off', {
+      paths: [],
+      patterns: [],
+    }],
+
+    // disallow to use this/super before super() calling in constructors.
+    // https://eslint.org/docs/rules/no-this-before-super
+    'no-this-before-super': 'error',
+
+    // disallow useless computed property keys
+    // https://eslint.org/docs/rules/no-useless-computed-key
+    'no-useless-computed-key': 'error',
+
+    // disallow unnecessary constructor
+    // https://eslint.org/docs/rules/no-useless-constructor
+    'no-useless-constructor': 'error',
+
+    // disallow renaming import, export, and destructured assignments to the same name
+    // https://eslint.org/docs/rules/no-useless-rename
+    'no-useless-rename': ['error', {
+      ignoreDestructuring: false,
+      ignoreImport: false,
+      ignoreExport: false,
+    }],
+
+    // require let or const instead of var
+    'no-var': 'error',
+
+    // require method and property shorthand syntax for object literals
+    // https://eslint.org/docs/rules/object-shorthand
+    'object-shorthand': ['error', 'always', {
+      ignoreConstructors: false,
+      avoidQuotes: true,
+    }],
+
+    // suggest using arrow functions as callbacks
+    'prefer-arrow-callback': ['error', {
+      allowNamedFunctions: false,
+      allowUnboundThis: true,
+    }],
+
+    // suggest using of const declaration for variables that are never modified after declared
+    'prefer-const': ['error', {
+      destructuring: 'any',
+      ignoreReadBeforeAssign: true,
+    }],
+
+    // Prefer destructuring from arrays and objects
+    // https://eslint.org/docs/rules/prefer-destructuring
+    'prefer-destructuring': ['error',
+      {
+        VariableDeclarator: {
+          array: false,
+          object: true,
+        },
+        AssignmentExpression: {
+          array: true,
+          object: false,
+        },
+      }, {
+        enforceForRenamedProperties: false,
+      },
+    ],
+
+    // disallow parseInt() in favor of binary, octal, and hexadecimal literals
+    // https://eslint.org/docs/rules/prefer-numeric-literals
+    'prefer-numeric-literals': 'error',
+
+    // suggest using Reflect methods where applicable
+    // https://eslint.org/docs/rules/prefer-reflect
+    'prefer-reflect': 'off',
+
+    // use rest parameters instead of arguments
+    // https://eslint.org/docs/rules/prefer-rest-params
+    'prefer-rest-params': 'error',
+
+    // suggest using the spread operator instead of .apply()
+    // https://eslint.org/docs/rules/prefer-spread
+    'prefer-spread': 'error',
+
+    // suggest using template literals instead of string concatenation
+    // https://eslint.org/docs/rules/prefer-template
+    'prefer-template': 'error',
+
+    // disallow generator functions that do not have yield
+    // https://eslint.org/docs/rules/require-yield
+    'require-yield': 'error',
+
+    // enforce spacing between object rest-spread
+    // https://eslint.org/docs/rules/rest-spread-spacing
+    'rest-spread-spacing': ['error', 'never'],
+
+    // import sorting
+    // https://eslint.org/docs/rules/sort-imports
+    'sort-imports': ['off', {
+      ignoreCase: false,
+      ignoreDeclarationSort: false,
+      ignoreMemberSort: false,
+      memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+    }],
+
+    // require a Symbol description
+    // https://eslint.org/docs/rules/symbol-description
+    'symbol-description': 'error',
+
+    // enforce usage of spacing in template strings
+    // https://eslint.org/docs/rules/template-curly-spacing
+    'template-curly-spacing': 'error',
+
+    // enforce spacing around the * in yield* expressions
+    // https://eslint.org/docs/rules/yield-star-spacing
+    'yield-star-spacing': ['error', 'after'],
+  },
+};

eslint-config/configs/base/rules/imports.js

@@ -0,0 +1,234 @@
+module.exports = {
+  env: {
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+  },
+  plugins: [
+    'import',
+  ],
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.mjs', '.js', '.json'],
+      },
+    },
+    'import/extensions': [
+      '.js',
+      '.mjs',
+      '.jsx',
+    ],
+    'import/core-modules': [],
+    'import/ignore': [
+      'node_modules',
+      '\\.(coffee|scss|css|less|hbs|svg|json)$',
+    ],
+  },
+  rules: {
+    // Static analysis:
+
+    // ensure imports point to files/modules that can be resolved
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md
+    'import/no-unresolved': ['error', { commonjs: true, caseSensitive: true }],
+
+    // ensure named imports coupled with named exports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/named.md#when-not-to-use-it
+    'import/named': 'error',
+
+    // ensure default import coupled with default export
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/default.md#when-not-to-use-it
+    'import/default': 'off',
+
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/namespace.md
+    'import/namespace': 'off',
+
+    // Helpful warnings:
+
+    // disallow invalid exports, e.g. multiple defaults
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/export.md
+    'import/export': 'error',
+
+    // do not allow a default import name to match a named export
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default.md
+    'import/no-named-as-default': 'error',
+
+    // warn on accessing default export property names that are also named exports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default-member.md
+    'import/no-named-as-default-member': 'error',
+
+    // disallow use of jsdoc-marked-deprecated imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md
+    'import/no-deprecated': 'off',
+
+    // Forbid the use of extraneous packages
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md
+    // paths are treated both as absolute paths, and relative to process.cwd()
+    'import/no-extraneous-dependencies': ['error'],
+
+    // Forbid mutable exports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md
+    'import/no-mutable-exports': 'error',
+
+    // Module systems:
+
+    // disallow require()
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-commonjs.md
+    'import/no-commonjs': 'off',
+
+    // disallow AMD require/define
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-amd.md
+    'import/no-amd': 'error',
+
+    // No Node.js builtin modules
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-nodejs-modules.md
+    // TODO: enable?
+    'import/no-nodejs-modules': 'off',
+
+    // Style guide:
+
+    // disallow non-import statements appearing before import statements
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/first.md
+    'import/first': 'error',
+
+    // disallow non-import statements appearing before import statements
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/imports-first.md
+    // deprecated: use `import/first`
+    'import/imports-first': 'off',
+
+    // disallow duplicate imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md
+    'import/no-duplicates': 'error',
+
+    // disallow namespace imports
+    // TODO: enable?
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-namespace.md
+    'import/no-namespace': 'off',
+
+    // Ensure consistent use of file extension within the import path
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md
+    'import/extensions': ['error', 'ignorePackages', {
+      js: 'never',
+      mjs: 'never',
+      jsx: 'never',
+    }],
+
+    // ensure absolute imports are above relative imports and that unassigned imports are ignored
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md
+    // TODO: enforce a stricter convention in module import order?
+    'import/order': ['error', { groups: [['builtin', 'external', 'internal']] }],
+
+    // Require a newline after the last import/require in a group
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/newline-after-import.md
+    'import/newline-after-import': 'error',
+
+    // Require modules with a single export to use a default export
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
+    'import/prefer-default-export': 'error',
+
+    // Restrict which files can be imported in a given folder
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-restricted-paths.md
+    'import/no-restricted-paths': 'off',
+
+    // Forbid modules to have too many dependencies
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/max-dependencies.md
+    'import/max-dependencies': ['off', { max: 10 }],
+
+    // Forbid import of modules using absolute paths
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-absolute-path.md
+    'import/no-absolute-path': 'error',
+
+    // Forbid require() calls with expressions
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-dynamic-require.md
+    'import/no-dynamic-require': 'error',
+
+    // prevent importing the submodules of other modules
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-internal-modules.md
+    'import/no-internal-modules': ['off', {
+      allow: [],
+    }],
+
+    // Warn if a module could be mistakenly parsed as a script by a consumer
+    // leveraging Unambiguous JavaScript Grammar
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/unambiguous.md
+    // this should not be enabled until this proposal has at least been *presented* to TC39.
+    // At the moment, it's not a thing.
+    'import/unambiguous': 'off',
+
+    // Forbid Webpack loader syntax in imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md
+    'import/no-webpack-loader-syntax': 'error',
+
+    // Prevent unassigned imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unassigned-import.md
+    // importing for side effects is perfectly acceptable, if you need side effects.
+    'import/no-unassigned-import': 'off',
+
+    // Prevent importing the default as if it were named
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-default.md
+    'import/no-named-default': 'error',
+
+    // Reports if a module's default export is unnamed
+    // https://github.com/benmosher/eslint-plugin-import/blob/d9b712ac7fd1fddc391f7b234827925c160d956f/docs/rules/no-anonymous-default-export.md
+    'import/no-anonymous-default-export': ['off', {
+      allowArray: false,
+      allowArrowFunction: false,
+      allowAnonymousClass: false,
+      allowAnonymousFunction: false,
+      allowLiteral: false,
+      allowObject: false,
+    }],
+
+    // This rule enforces that all exports are declared at the bottom of the file.
+    // https://github.com/benmosher/eslint-plugin-import/blob/98acd6afd04dcb6920b81330114e146dc8532ea4/docs/rules/exports-last.md
+    // TODO: enable?
+    'import/exports-last': 'off',
+
+    // Reports when named exports are not grouped together in a single export declaration
+    // or when multiple assignments to CommonJS module.exports or exports object are present
+    // in a single file.
+    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/group-exports.md
+    'import/group-exports': 'off',
+
+    // forbid default exports. this is a terrible rule, do not use it.
+    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-default-export.md
+    'import/no-default-export': 'off',
+
+    // Prohibit named exports. this is a terrible rule, do not use it.
+    // https://github.com/benmosher/eslint-plugin-import/blob/1ec80fa35fa1819e2d35a70e68fb6a149fb57c5e/docs/rules/no-named-export.md
+    'import/no-named-export': 'off',
+
+    // Forbid a module from importing itself
+    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-self-import.md
+    'import/no-self-import': 'error',
+
+    // Forbid cyclical dependencies between modules
+    // https://github.com/benmosher/eslint-plugin-import/blob/d81f48a2506182738409805f5272eff4d77c9348/docs/rules/no-cycle.md
+    'import/no-cycle': ['error', { maxDepth: Infinity }],
+
+    // Ensures that there are no useless path segments
+    // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/no-useless-path-segments.md
+    'import/no-useless-path-segments': ['error', { commonjs: true }],
+
+    // dynamic imports require a leading comment with a webpackChunkName
+    // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/dynamic-import-chunkname.md
+    'import/dynamic-import-chunkname': ['off', {
+      importFunctions: [],
+      webpackChunknameFormat: '[0-9a-zA-Z-_/.]+',
+    }],
+
+    // Use this rule to prevent imports to folders in relative parent paths.
+    // https://github.com/benmosher/eslint-plugin-import/blob/c34f14f67f077acd5a61b3da9c0b0de298d20059/docs/rules/no-relative-parent-imports.md
+    'import/no-relative-parent-imports': 'off',
+
+    // Reports modules without any exports, or with unused exports
+    // https://github.com/benmosher/eslint-plugin-import/blob/f63dd261809de6883b13b6b5b960e6d7f42a7813/docs/rules/no-unused-modules.md
+    // TODO: enable, semver-major
+    'import/no-unused-modules': ['off', {
+      ignoreExports: [],
+      missingExports: true,
+      unusedExports: true,
+    }],
+  },
+};

eslint-config/configs/base/rules/style.js

@@ -0,0 +1,525 @@
+module.exports = {
+  rules: {
+    // enforce line breaks after opening and before closing array brackets
+    // https://eslint.org/docs/rules/array-bracket-newline
+    // TODO: enable? semver-major
+    'array-bracket-newline': ['off', 'consistent'], // object option alternative: { multiline: true, minItems: 3 }
+
+    // enforce line breaks between array elements
+    // https://eslint.org/docs/rules/array-element-newline
+    // TODO: enable? semver-major
+    'array-element-newline': ['off', { multiline: true, minItems: 3 }],
+
+    // enforce spacing inside array brackets
+    'array-bracket-spacing': ['error', 'never'],
+
+    // enforce spacing inside single-line blocks
+    // https://eslint.org/docs/rules/block-spacing
+    'block-spacing': ['error', 'always'],
+
+    // enforce one true brace style
+    'brace-style': ['error', '1tbs', { allowSingleLine: true }],
+
+    // require camel case names
+    camelcase: ['error', { properties: 'never', ignoreDestructuring: false }],
+
+    // enforce or disallow capitalization of the first letter of a comment
+    // https://eslint.org/docs/rules/capitalized-comments
+    'capitalized-comments': ['off', 'never', {
+      line: {
+        ignorePattern: '.*',
+        ignoreInlineComments: true,
+        ignoreConsecutiveComments: true,
+      },
+      block: {
+        ignorePattern: '.*',
+        ignoreInlineComments: true,
+        ignoreConsecutiveComments: true,
+      },
+    }],
+
+    // require trailing commas in multiline object literals
+    'comma-dangle': ['error', {
+      arrays: 'always-multiline',
+      objects: 'always-multiline',
+      imports: 'always-multiline',
+      exports: 'always-multiline',
+      functions: 'always-multiline',
+    }],
+
+    // enforce spacing before and after comma
+    'comma-spacing': ['error', { before: false, after: true }],
+
+    // enforce one true comma style
+    'comma-style': ['error', 'last', {
+      exceptions: {
+        ArrayExpression: false,
+        ArrayPattern: false,
+        ArrowFunctionExpression: false,
+        CallExpression: false,
+        FunctionDeclaration: false,
+        FunctionExpression: false,
+        ImportDeclaration: false,
+        ObjectExpression: false,
+        ObjectPattern: false,
+        VariableDeclaration: false,
+        NewExpression: false,
+      },
+    }],
+
+    // disallow padding inside computed properties
+    'computed-property-spacing': ['error', 'never'],
+
+    // enforces consistent naming when capturing the current execution context
+    'consistent-this': 'off',
+
+    // enforce newline at the end of file, with no multiple empty lines
+    'eol-last': ['error', 'always'],
+
+    // https://eslint.org/docs/rules/function-call-argument-newline
+    // TODO: enable, semver-minor, once eslint v6.2 is required (which is a major)
+    'function-call-argument-newline': ['off', 'consistent'],
+
+    // enforce spacing between functions and their invocations
+    // https://eslint.org/docs/rules/func-call-spacing
+    'func-call-spacing': ['error', 'never'],
+
+    // requires function names to match the name of the variable or property to which they are
+    // assigned
+    // https://eslint.org/docs/rules/func-name-matching
+    'func-name-matching': ['off', 'always', {
+      includeCommonJSModuleExports: false,
+      considerPropertyDescriptor: true,
+    }],
+
+    // require function expressions to have a name
+    // https://eslint.org/docs/rules/func-names
+    'func-names': 'warn',
+
+    // enforces use of function declarations or expressions
+    // https://eslint.org/docs/rules/func-style
+    // TODO: enable
+    'func-style': ['off', 'expression'],
+
+    // enforce consistent line breaks inside function parentheses
+    // https://eslint.org/docs/rules/function-paren-newline
+    'function-paren-newline': ['error', 'consistent'],
+
+    // Blacklist certain identifiers to prevent them being used
+    // https://eslint.org/docs/rules/id-blacklist
+    'id-blacklist': 'off',
+
+    // this option enforces minimum and maximum identifier lengths
+    // (variable names, property names etc.)
+    'id-length': 'off',
+
+    // require identifiers to match the provided regular expression
+    'id-match': 'off',
+
+    // Enforce the location of arrow function bodies with implicit returns
+    // https://eslint.org/docs/rules/implicit-arrow-linebreak
+    'implicit-arrow-linebreak': ['error', 'beside'],
+
+    // this option sets a specific tab width for your code
+    // https://eslint.org/docs/rules/indent
+    indent: ['error', 2, {
+      SwitchCase: 1,
+      VariableDeclarator: 1,
+      outerIIFEBody: 1,
+      // MemberExpression: null,
+      FunctionDeclaration: {
+        parameters: 1,
+        body: 1,
+      },
+      FunctionExpression: {
+        parameters: 1,
+        body: 1,
+      },
+      CallExpression: {
+        arguments: 1,
+      },
+      ArrayExpression: 1,
+      ObjectExpression: 1,
+      ImportDeclaration: 1,
+      flatTernaryExpressions: false,
+      // list derived from https://github.com/benjamn/ast-types/blob/HEAD/def/jsx.js
+      ignoredNodes: ['JSXElement', 'JSXElement > *', 'JSXAttribute', 'JSXIdentifier', 'JSXNamespacedName', 'JSXMemberExpression', 'JSXSpreadAttribute', 'JSXExpressionContainer', 'JSXOpeningElement', 'JSXClosingElement', 'JSXText', 'JSXEmptyExpression', 'JSXSpreadChild'],
+      ignoreComments: false,
+    }],
+
+    // specify whether double or single quotes should be used in JSX attributes
+    // https://eslint.org/docs/rules/jsx-quotes
+    'jsx-quotes': ['off', 'prefer-double'],
+
+    // enforces spacing between keys and values in object literal properties
+    'key-spacing': ['error', { beforeColon: false, afterColon: true }],
+
+    // require a space before & after certain keywords
+    'keyword-spacing': ['error', {
+      before: true,
+      after: true,
+      overrides: {
+        return: { after: true },
+        throw: { after: true },
+        case: { after: true },
+      },
+    }],
+
+    // enforce position of line comments
+    // https://eslint.org/docs/rules/line-comment-position
+    // TODO: enable?
+    'line-comment-position': ['off', {
+      position: 'above',
+      ignorePattern: '',
+      applyDefaultPatterns: true,
+    }],
+
+    // disallow mixed 'LF' and 'CRLF' as linebreaks
+    // https://eslint.org/docs/rules/linebreak-style
+    'linebreak-style': ['error', 'unix'],
+
+    // require or disallow an empty line between class members
+    // https://eslint.org/docs/rules/lines-between-class-members
+    'lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: false }],
+
+    // enforces empty lines around comments
+    'lines-around-comment': 'off',
+
+    // require or disallow newlines around directives
+    // https://eslint.org/docs/rules/lines-around-directive
+    'lines-around-directive': ['error', {
+      before: 'always',
+      after: 'always',
+    }],
+
+    // specify the maximum depth that blocks can be nested
+    'max-depth': ['off', 4],
+
+    // specify the maximum length of a line in your program
+    // https://eslint.org/docs/rules/max-len
+    'max-len': ['off'],
+
+    // specify the max number of lines in a file
+    // https://eslint.org/docs/rules/max-lines
+    'max-lines': ['off', {
+      max: 300,
+      skipBlankLines: true,
+      skipComments: true,
+    }],
+
+    // enforce a maximum function length
+    // https://eslint.org/docs/rules/max-lines-per-function
+    'max-lines-per-function': ['off', {
+      max: 50,
+      skipBlankLines: true,
+      skipComments: true,
+      IIFEs: true,
+    }],
+
+    // specify the maximum depth callbacks can be nested
+    'max-nested-callbacks': 'off',
+
+    // limits the number of parameters that can be used in the function declaration.
+    'max-params': ['off', 3],
+
+    // specify the maximum number of statement allowed in a function
+    'max-statements': ['off', 10],
+
+    // restrict the number of statements per line
+    // https://eslint.org/docs/rules/max-statements-per-line
+    'max-statements-per-line': ['off', { max: 1 }],
+
+    // enforce a particular style for multiline comments
+    // https://eslint.org/docs/rules/multiline-comment-style
+    'multiline-comment-style': ['off', 'starred-block'],
+
+    // require multiline ternary
+    // https://eslint.org/docs/rules/multiline-ternary
+    // TODO: enable?
+    'multiline-ternary': ['off', 'never'],
+
+    // require a capital letter for constructors
+    'new-cap': ['error', {
+      newIsCap: true,
+      newIsCapExceptions: [],
+      capIsNew: false,
+      capIsNewExceptions: ['Immutable.Map', 'Immutable.Set', 'Immutable.List'],
+    }],
+
+    // disallow the omission of parentheses when invoking a constructor with no arguments
+    // https://eslint.org/docs/rules/new-parens
+    'new-parens': 'error',
+
+    // allow/disallow an empty newline after var statement
+    'newline-after-var': 'off',
+
+    // https://eslint.org/docs/rules/newline-before-return
+    'newline-before-return': 'off',
+
+    // enforces new line after each method call in the chain to make it
+    // more readable and easy to maintain
+    // https://eslint.org/docs/rules/newline-per-chained-call
+    'newline-per-chained-call': ['error', { ignoreChainWithDepth: 4 }],
+
+    // disallow use of the Array constructor
+    'no-array-constructor': 'error',
+
+    // disallow use of bitwise operators
+    // https://eslint.org/docs/rules/no-bitwise
+    'no-bitwise': 'error',
+
+    // disallow use of the continue statement
+    // https://eslint.org/docs/rules/no-continue
+    'no-continue': 'error',
+
+    // disallow comments inline after code
+    'no-inline-comments': 'off',
+
+    // disallow if as the only statement in an else block
+    // https://eslint.org/docs/rules/no-lonely-if
+    'no-lonely-if': 'error',
+
+    // disallow un-paren'd mixes of different operators
+    // https://eslint.org/docs/rules/no-mixed-operators
+    'no-mixed-operators': ['error', {
+      // the list of arthmetic groups disallows mixing `%` and `**`
+      // with other arithmetic operators.
+      groups: [
+        ['%', '**'],
+        ['%', '+'],
+        ['%', '-'],
+        ['%', '*'],
+        ['%', '/'],
+        ['/', '*'],
+        ['&', '|', '<<', '>>', '>>>'],
+        ['==', '!=', '===', '!=='],
+        ['&&', '||'],
+      ],
+      allowSamePrecedence: false,
+    }],
+
+    // disallow mixed spaces and tabs for indentation
+    'no-mixed-spaces-and-tabs': 'error',
+
+    // disallow use of chained assignment expressions
+    // https://eslint.org/docs/rules/no-multi-assign
+    'no-multi-assign': ['error'],
+
+    // disallow multiple empty lines, only one newline at the end, and no new lines at the beginning
+    // https://eslint.org/docs/rules/no-multiple-empty-lines
+    'no-multiple-empty-lines': ['error', { max: 2, maxBOF: 1, maxEOF: 0 }],
+
+    // disallow negated conditions
+    // https://eslint.org/docs/rules/no-negated-condition
+    'no-negated-condition': 'off',
+
+    // disallow nested ternary expressions
+    'no-nested-ternary': 'error',
+
+    // disallow use of the Object constructor
+    'no-new-object': 'error',
+
+    // disallow use of unary operators, ++ and --
+    // https://eslint.org/docs/rules/no-plusplus
+    'no-plusplus': 'error',
+
+    // disallow certain syntax forms
+    // https://eslint.org/docs/rules/no-restricted-syntax
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector: 'ForInStatement',
+        message: 'for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.',
+      },
+      {
+        selector: 'ForOfStatement',
+        message: 'iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations.',
+      },
+      {
+        selector: 'LabeledStatement',
+        message: 'Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.',
+      },
+      {
+        selector: 'WithStatement',
+        message: '`with` is disallowed in strict mode because it makes code impossible to predict and optimize.',
+      },
+    ],
+
+    // disallow space between function identifier and application
+    'no-spaced-func': 'error',
+
+    // disallow tab characters entirely
+    'no-tabs': 'error',
+
+    // disallow the use of ternary operators
+    'no-ternary': 'off',
+
+    // disallow trailing whitespace at the end of lines
+    'no-trailing-spaces': ['error', {
+      skipBlankLines: false,
+      ignoreComments: false,
+    }],
+
+    // disallow dangling underscores in identifiers
+    // https://eslint.org/docs/rules/no-underscore-dangle
+    'no-underscore-dangle': ['error', {
+      allow: [],
+      allowAfterThis: false,
+      allowAfterSuper: false,
+      enforceInMethodNames: true,
+    }],
+
+    // disallow the use of Boolean literals in conditional expressions
+    // also, prefer `a || b` over `a ? a : b`
+    // https://eslint.org/docs/rules/no-unneeded-ternary
+    'no-unneeded-ternary': ['error', { defaultAssignment: false }],
+
+    // disallow whitespace before properties
+    // https://eslint.org/docs/rules/no-whitespace-before-property
+    'no-whitespace-before-property': 'error',
+
+    // enforce the location of single-line statements
+    // https://eslint.org/docs/rules/nonblock-statement-body-position
+    'nonblock-statement-body-position': ['error', 'beside', { overrides: {} }],
+
+    // require padding inside curly braces
+    'object-curly-spacing': ['error', 'always'],
+
+    // enforce line breaks between braces
+    // https://eslint.org/docs/rules/object-curly-newline
+    'object-curly-newline': ['error', {
+      ObjectExpression: { multiline: true, consistent: true },
+      ObjectPattern: { multiline: true, consistent: true },
+      ImportDeclaration: { multiline: true, consistent: true },
+      ExportDeclaration: { multiline: true, consistent: true },
+    }],
+
+    // enforce "same line" or "multiple line" on object properties.
+    // https://eslint.org/docs/rules/object-property-newline
+    'object-property-newline': ['error', {
+      allowAllPropertiesOnSameLine: true,
+    }],
+
+    // allow just one var statement per function
+    'one-var': ['error', 'never'],
+
+    // require a newline around variable declaration
+    // https://eslint.org/docs/rules/one-var-declaration-per-line
+    'one-var-declaration-per-line': ['error', 'always'],
+
+    // require assignment operator shorthand where possible or prohibit it entirely
+    // https://eslint.org/docs/rules/operator-assignment
+    'operator-assignment': ['error', 'always'],
+
+    // Requires operator at the beginning of the line in multiline statements
+    // https://eslint.org/docs/rules/operator-linebreak
+    'operator-linebreak': ['error', 'before', { overrides: { '=': 'none' } }],
+
+    // disallow padding within blocks
+    'padded-blocks': ['error',
+      {
+        blocks: 'never',
+        classes: 'never',
+        switches: 'never',
+      },
+      {
+        allowSingleLineBlocks: true,
+      },
+    ],
+
+    // Require or disallow padding lines between statements
+    // https://eslint.org/docs/rules/padding-line-between-statements
+    'padding-line-between-statements': 'off',
+
+    // Disallow the use of Math.pow in favor of the ** operator
+    // https://eslint.org/docs/rules/prefer-exponentiation-operator
+    // TODO: enable, semver-major when eslint 5 is dropped
+    'prefer-exponentiation-operator': 'off',
+
+    // Prefer use of an object spread over Object.assign
+    // https://eslint.org/docs/rules/prefer-object-spread
+    'prefer-object-spread': 'error',
+
+    // require quotes around object literal property names
+    // https://eslint.org/docs/rules/quote-props.html
+    'quote-props': ['error', 'as-needed', { keywords: false, unnecessary: true, numbers: false }],
+
+    // specify whether double or single quotes should be used
+    quotes: ['error', 'single', { avoidEscape: true }],
+
+    // do not require jsdoc
+    // https://eslint.org/docs/rules/require-jsdoc
+    'require-jsdoc': 'off',
+
+    // require or disallow use of semicolons instead of ASI
+    semi: ['error', 'always'],
+
+    // enforce spacing before and after semicolons
+    'semi-spacing': ['error', { before: false, after: true }],
+
+    // Enforce location of semicolons
+    // https://eslint.org/docs/rules/semi-style
+    'semi-style': ['error', 'last'],
+
+    // requires object keys to be sorted
+    'sort-keys': ['off', 'asc', { caseSensitive: false, natural: true }],
+
+    // sort variables within the same declaration block
+    'sort-vars': 'off',
+
+    // require or disallow space before blocks
+    'space-before-blocks': 'error',
+
+    // require or disallow space before function opening parenthesis
+    // https://eslint.org/docs/rules/space-before-function-paren
+    'space-before-function-paren': ['error', {
+      anonymous: 'always',
+      named: 'never',
+      asyncArrow: 'always',
+    }],
+
+    // require or disallow spaces inside parentheses
+    'space-in-parens': ['error', 'never'],
+
+    // require spaces around operators
+    'space-infix-ops': 'error',
+
+    // Require or disallow spaces before/after unary operators
+    // https://eslint.org/docs/rules/space-unary-ops
+    'space-unary-ops': ['error', {
+      words: true,
+      nonwords: false,
+      overrides: {
+      },
+    }],
+
+    // require or disallow a space immediately following the // or /* in a comment
+    // https://eslint.org/docs/rules/spaced-comment
+    'spaced-comment': ['error', 'always', {
+      line: {
+        exceptions: ['-', '+'],
+        markers: ['=', '!'], // space here to support sprockets directives
+      },
+      block: {
+        exceptions: ['-', '+'],
+        markers: ['=', '!', ':', '::'], // space here to support sprockets directives and flow comment types
+        balanced: true,
+      },
+    }],
+
+    // Enforce spacing around colons of switch statements
+    // https://eslint.org/docs/rules/switch-colon-spacing
+    'switch-colon-spacing': ['error', { after: true, before: false }],
+
+    // Require or disallow spacing between template tags and their literals
+    // https://eslint.org/docs/rules/template-tag-spacing
+    'template-tag-spacing': ['error', 'never'],
+
+    // require or disallow the Unicode Byte Order Mark
+    // https://eslint.org/docs/rules/unicode-bom
+    'unicode-bom': ['error', 'never'],
+
+    // require regex literals to be wrapped in parentheses
+    'wrap-regex': 'off',
+  },
+};

eslint-config/configs/base/rules/variables.js

@@ -0,0 +1,44 @@
+const confusingBrowserGlobals = require('confusing-browser-globals');
+
+module.exports = {
+  rules: {
+    // enforce or disallow variable initializations at definition
+    'init-declarations': 'off',
+
+    // disallow the catch clause parameter name being the same as a variable in the outer scope
+    'no-catch-shadow': 'off',
+
+    // disallow deletion of variables
+    'no-delete-var': 'error',
+
+    // disallow labels that share a name with a variable
+    // https://eslint.org/docs/rules/no-label-var
+    'no-label-var': 'error',
+
+    // disallow specific globals
+    'no-restricted-globals': ['error', 'isFinite', 'isNaN'].concat(confusingBrowserGlobals),
+
+    // disallow declaration of variables already declared in the outer scope
+    'no-shadow': 'error',
+
+    // disallow shadowing of names such as arguments
+    'no-shadow-restricted-names': 'error',
+
+    // disallow use of undeclared variables unless mentioned in a /*global */ block
+    'no-undef': 'error',
+
+    // disallow use of undefined when initializing variables
+    'no-undef-init': 'error',
+
+    // disallow use of undefined variable
+    // https://eslint.org/docs/rules/no-undefined
+    // TODO: enable?
+    'no-undefined': 'off',
+
+    // disallow declaration of variables that are not used in the code
+    'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
+
+    // disallow use of variables before they are defined
+    'no-use-before-define': ['error', { functions: true, classes: true, variables: true }],
+  },
+};

eslint-config/configs/jest/index.js

@@ -0,0 +1,14 @@
+module.exports = {
+  env: {
+    jest: true,
+  },
+  plugins: [
+    'jest',
+    'jest-dom',
+  ],
+  extends: [
+    './rules/jest',
+    './rules/jest-dom',
+  ].map(require.resolve),
+  rules: {},
+};