chore(release): @payloadcms/db-postgres/0.1.7

fix(db-postgres): query relationship in array alias

.git-blame-ignore-revs

@@ -10,3 +10,9 @@ cdaa0acd61d3001407609915bd573b78565d5571
 
 # prettier write again
 dfac7395fed95fc5d8ebca21b786ce70821942bb
+
+# lint and format plugin-cloud
+fb7d1be2f3325d076b7c967b1730afcef37922c2
+
+# lint and format create-payload-app
+5fd3d430001efe86515262ded5e26f00c1451181

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -31,6 +31,11 @@ body:
       description: What version of Payload are you running?
     validations:
       required: true
+  - type: input
+    id: adapters-plugins
+    attributes:
+      label: Adapters and Plugins
+      description: What adapters and plugins are you using? ie. db-mongodb, db-postgres, bundler-webpack, etc.
   - type: markdown
     attributes:
       value: Before submitting the issue, go through the steps you've written down to make sure the steps provided are detailed and clear.

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,7 +2,7 @@
 
 <!-- Please include a summary of the pull request and any related issues it fixes. Please also include relevant motivation and context. -->
 
-- [ ] I have read and understand the [CONTRIBUTING.md](../CONTRIBUTING.md) document in this repository.
+- [ ] I have read and understand the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository.
 
 ## Type of change
 

.github/workflows/main.yml

@@ -108,6 +108,10 @@ jobs:
   tests-e2e:
     runs-on: ubuntu-latest
     needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        part: [1/4, 2/4, 3/4, 4/4]
 
     steps:
       - name: Use Node.js 18
@@ -128,14 +132,14 @@ jobs:
           key: ${{ github.sha }}-${{ github.run_number }}
 
       - name: E2E Tests
-        run: pnpm test:e2e --bail
+        run: pnpm test:e2e --part ${{ matrix.part }} --bail
 
       - uses: actions/upload-artifact@v3
         if: always()
         with:
           name: test-results
           path: test-results/
-          retention-days: 30
+          retention-days: 1
 
   tests-type-generation:
     runs-on: ubuntu-latest
@@ -165,11 +169,21 @@ jobs:
       - name: Generate GraphQL schema file
         run: pnpm dev:generate-graphql-schema graphql-schema-gen
 
-# DB Adapters
-
-  build-db-mongodb:
+  build-packages:
     runs-on: ubuntu-latest
     needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg:
+          - db-mongodb
+          - db-postgres
+          - bundler-webpack
+          - bundler-vite
+          - richtext-slate
+          - richtext-lexical
+          - live-preview
+          - live-preview-react
 
     steps:
       - name: Use Node.js 18
@@ -189,12 +203,18 @@ jobs:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
 
-      - name: Build db-mongodb
-        run: pnpm turbo run build --filter=db-mongodb
+      - name: Build ${{ matrix.pkg }}
+        run: pnpm turbo run build --filter=${{ matrix.pkg }}
 
-  build-db-postgres:
+  plugins:
     runs-on: ubuntu-latest
     needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg:
+          - plugin-cloud
+          - create-payload-app
 
     steps:
       - name: Use Node.js 18
@@ -214,137 +234,9 @@ jobs:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
 
-      - name: Build db-postgres
-        run: pnpm turbo run build --filter=db-postgres
+      - name: Build ${{ matrix.pkg }}
+        run: pnpm turbo run build --filter=${{ matrix.pkg }}
 
-# Bundlers
-
-  build-bundler-webpack:
-    runs-on: ubuntu-latest
-    needs: core-build
-
-    steps:
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 8
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v3
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build bundler-webpack
-        run: pnpm turbo run build --filter=bundler-webpack
-
-  build-bundler-vite:
-    runs-on: ubuntu-latest
-    needs: core-build
-
-    steps:
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 8
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v3
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build bundler-vite
-        run: pnpm turbo run build --filter=bundler-vite
-
-# Other Plugins
-
-  build-plugin-richtext-slate:
-    runs-on: ubuntu-latest
-    needs: core-build
-
-    steps:
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 8
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v3
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build richtext-slate
-        run: pnpm turbo run build --filter=richtext-slate
-
-  build-plugin-richtext-lexical:
-    runs-on: ubuntu-latest
-    needs: core-build
-
-    steps:
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 8
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v3
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build richtext-lexical
-        run: pnpm turbo run build --filter=richtext-lexical
-
-  build-plugin-live-preview:
-    runs-on: ubuntu-latest
-    needs: core-build
-
-    steps:
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 8
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v3
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build live-preview
-        run: pnpm turbo run build --filter=live-preview
-
-      - name: Build live-preview-react
-        run: pnpm turbo run build --filter=live-preview-react
+      - name: Test ${{ matrix.pkg }}
+        run: pnpm --filter ${{ matrix.pkg }} run test
+        if: matrix.pkg != 'create-payload-app' # degit doesn't work within GitHub Actions

.vscode/launch.json

@@ -17,7 +17,7 @@
       "type": "node-terminal"
     },
     {
-      "command": "pnpm run dev:postgres collections-graphql",
+      "command": "pnpm run dev:postgres fields",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Postgres",
       "request": "launch",

CHANGELOG.md

@@ -51,11 +51,29 @@ export default buildConfig({
 
 These new properties are all now required for Payload to function, and you will have to install each separate adapter that you use. Feel free to swap out any of the adapters with your choice (Lexical, Postgres, Vite, etc.)
 
+Make sure to install the packages that you need. In the above example, you would need to install the following:
+
+```bash
+npm install --save @payloadcms/db-mongodb @payloadcms/richtext-slate @payloadcms/bundler-webpack
+```
+
 ### ⚠️ Draft versions now require a `latest: true` property to be set on the most recent draft in your `_versions` collections(s)
 
 We have a ready-to-go migration script for your versions from v1 to v2, and to use it, all you have to do is run the following commands:
 
-**1. Create a migration, using the new Payload migration API**
+**1. First, make sure you have a `payload` npm script in your `package.json`**
+
+```json
+{
+  "scripts": {
+    "payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload"
+  }
+}
+```
+
+Adjust the `PAYLOAD_CONFIG_PATH` to point to your Payload config file if necessary.
+
+**2. Create a migration, using the new Payload migration API**
 
 ```bash
 npm run payload migrate:create --file @payloadcms/db-mongodb/versions-v1-v2
@@ -63,7 +81,7 @@ npm run payload migrate:create --file @payloadcms/db-mongodb/versions-v1-v2
 
 The above command will output a migration file into your `./src/migrations` folder (default migrations location). It contains a migration script to automatically add a `latest: true` flag to each of your newest drafts, for all draft-enabled collections. It works out of the box!
 
-**2. Run migrations**
+**3. Run migrations**
 
 From there, you need to run migrations. Run the following command to execute your new migration:
 
@@ -103,6 +121,12 @@ This means that in some fringe cases, if you are creating a doc and then instant
 
 To avoid any issues, you can pass the `req.transactionID` through to your Local API calls, so that your Local API calls are included as part of the parent transaction.
 
+### ⚠️ Locales now have more functionality, and in some places, you might need to update custom code
+
+Payload's locales have become more powerful and now allow you to customize more aspects per locale such as a human-friendly label and if the locale is RTL or not. 
+
+This means that certain functions now return a different shape, such as `useLocale`. This hook used to return a string of the locale code you are currently editing, but it now returns an object with type of `Locale`.
+
 ### ⚠️ Admin panel CSS classes may have changed
 
 The revisions we've made in 2.0 required changes to both HTML and CSS within the admin panel. For this reason, if you were loading custom CSS into the admin panel to customize the look and feel, your stylesheets may need to be updated. If your CSS is targeting elements on the page using HTML selectors or class names, you may need to update these selectors based on the current markup. It may also be necessary to update your style definitions if the core Payload component you are targeting has undergone significant change.

README.md

@@ -25,6 +25,10 @@
 <a target="_blank" href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the Docs</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://payloadcms.com/community-help" rel="dofollow"><strong>Community Help</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://demo.payloadcms.com/" rel="dofollow"><strong>Try Live Demo</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://github.com/payloadcms/payload/discussions/1539" rel="dofollow"><strong>Roadmap</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://www.g2.com/products/payload-cms/reviews#reviews" rel="dofollow"><strong>View G2 Reviews</strong></a>
 </h4>
 <hr/>
+
+> [!IMPORTANT]
+> 🎉 <strong>Payload 2.0 is now available!<strong> Read more in the <a target="_blank" href="https://payloadcms.com/blog/payload-2-0" rel="dofollow"><strong>announcement post</strong></a>.
+
 <h3>Benefits over a regular CMS</h3>
 <ul>
   <li>Don’t hit some third-party SaaS API, hit your own API</li>
@@ -95,6 +99,8 @@ We're constantly adding more templates to our [Templates Directory](https://gith
 
 Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
 
+Migrating from v1 to v2? Check out the [2.0 Release Notes](https://github.com/payloadcms/payload/releases/tag/v2.0.0) on how to do it.
+
 ## 🙋 Contributing
 
 If you want to add contributions to this repository, please follow the instructions in [contributing.md](./CONTRIBUTING.md).

docs/admin/bundlers.mdx

@@ -12,13 +12,13 @@ Payload has two official bundlers, the [Webpack Bundler](/docs/admin/webpack) an
 Webpack (recommended):
 
 ```text
-yarn add @payloadcms/webpack-bundler
+yarn add @payloadcms/bundler-webpack
 ```
 
 Vite (beta):
 
 ```text
-yarn add @payloadcms/vite-bundler
+yarn add @payloadcms/bundler-vite
 ```
 
 ##### Configure the bundler

docs/admin/components.mdx

@@ -72,7 +72,7 @@ export default buildConfig({
 
 #### Views
 
-You can easily swap entire views with your own by using the `admin.components.views` property. At the root level, Payload renders the following views that can be overridden:
+You can easily swap entire views with your own by using the `admin.components.views` property. At the root level, Payload renders the following views dy default, all of which can be overridden:
 
 | Property           | Description                                                                                                                  |
 | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
@@ -84,6 +84,7 @@ To swap out any of these views, simply pass in your custom component to the `adm
 ```ts
 // payload.config.ts
 {
+  // ...
   admin: {
     components: {
       views: {
@@ -114,6 +115,7 @@ To add a _new_ view to the Admin Panel, simply add another key to the `views` ob
 ```ts
 // payload.config.ts
 {
+  // ...
   admin: {
     components: {
       views: {
@@ -127,7 +129,9 @@ To add a _new_ view to the Admin Panel, simply add another key to the `views` ob
 }
 ```
 
-_For more examples regarding how to customize components, look at the following [examples](https://github.com/payloadcms/payload/tree/master/test/admin/components)._ For help on how to build your own custom view components, see the [Building a custom view component](#building-a-custom-view-component) section.
+_For more examples regarding how to customize components, look at the following [examples](https://github.com/payloadcms/payload/tree/main/test/admin/components)._
+
+For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component).
 
 ### Collections
 
@@ -207,19 +211,19 @@ export const MyCollection: SanitizedCollectionConfig = {
 
 #### Collection views
 
-To swap out entire views on collections, you can use the `admin.components.views` property on the collection's config. Payload renders the following views by default that can be overridden:
+To swap out entire views on collections, you can use the `admin.components.views` property on the collection's config. Payload renders the following views dy default, all of which can be overridden:
 
 | Property           | Description                                                                                                                  |
 | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`Edit`**         | The Edit view is used to edit a single document for a given Collection.                                                      |
-| **`List`**         | The List view is used to show a list of documents for a given Collection.                                                    |
+| **`Edit`**         | The Edit view is used to edit a single document for a given collection.                                                      |
+| **`List`**         | The List view is used to show a list of documents for a given collection.                                                    |
 
-To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. For example:
+To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, tabs, etc, _as well as all nested routes_.
 
 ```ts
 // Collection.ts
-export const MyCollection: SanitizedCollectionConfig = {
-  slug: 'my-collection',
+{
+  // ...
   admin: {
     components: {
       views: {
@@ -231,7 +235,27 @@ export const MyCollection: SanitizedCollectionConfig = {
 }
 ```
 
-To swap or add new _tabs_ to the `Edit` view, you can use the `admin.components.views.Edit` property on the collection's config. See the [Custom Tabs](#custom-tabs) section for more information. For help on how to build your own custom view components, see the [Building a custom view component](#building-a-custom-view-component) section.
+_For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component)._
+
+To swap specific _nested_ views within the parent `Edit` view, you can use the `admin.components.views.Edit` property on the globals's config. This will only replace the nested view, leaving the page breadcrumbs, title, tabs, etc intact.
+
+```ts
+// Collection.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        Edit: {
+          Default: MyCustomDefaultTab,
+        },
+      },
+    },
+  },
+}
+```
+
+You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
 
 ### Globals
 
@@ -247,17 +271,18 @@ As with Collections, you can override components on a global-by-global basis via
 
 #### Global views
 
-To swap out views for globals, you can use the `admin.components.views` property on the global's config. Payload renders the following views by default that you can override:
+To swap out views for globals, you can use the `admin.components.views` property on the global's config. Payload renders the following views dy default, all of which can be overridden:
 
 | Property           | Description                                                                                                                  |
 | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
 | **`Edit`**         | The Edit view is used to edit a single document for a given Global.                                                          |
 
-To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. For example:
+To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, and tabs, _as well as all nested views_.
 
 ```ts
-export const MyGlobal: SanitizedGlobalConfig = {
-  slug: 'my-global',
+// Global.ts
+{
+  // ...
   admin: {
     components: {
       views: {
@@ -268,17 +293,37 @@ export const MyGlobal: SanitizedGlobalConfig = {
 }
 ```
 
-To swap or add new _tabs_ to the `Edit` view, you can use the `admin.components.views.Edit` property on the collection's config. See the [Custom Tabs](#custom-tabs) section for more information. For help on how to build your own custom view components, see the [Building a custom view component](#building-a-custom-view-component) section.
+_For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component)._
+
+To swap specific _nested_ views within the parent `Edit` view, you can use the `admin.components.views.Edit` property on the globals's config. This will only replace the nested view, leaving the page breadcrumbs, title, and tabs intact.
+
+```ts
+// Global.ts
+{
+  // ...
+  admin: {
+    components: {
+      views: {
+        Edit: {
+          Default: MyCustomDefaultTab,
+        },
+      },
+    },
+  },
+}
+```
+
+You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
 
 ### Custom Tabs
 
-To can swap collection or global tabs, pass an _object_ to the `admin.components.views.Edit` property on any collection or global config. Payload renders the following views by default which can be overridden:
+You can easily swap individual collection or global edit views. To do this, pass an _object_ to the `admin.components.views.Edit` property of the config. Payload renders the following views dy default, all of which can be overridden:
 
 | Property           | Description                                                                                                                  |
 | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
 | **`Default`**      | The Default view is the primary view in which your document is edited.                                                       |
 | **`Versions`**     | The Versions view is used to view the version history of a single document. [More details](../versions)                      |
-| **`Version`**      | The Version view is used to view a single version of a single document for a given Collection. [More details](../versions).  |
+| **`Version`**      | The Version view is used to view a single version of a single document for a given collection. [More details](../versions).  |
 | **`API`**          | The API view is used to display the REST API JSON response for a given document.                                             |
 | **`LivePreview`**  | The LivePreview view is used to display the Live Preview interface. [More details](../live-preview)                          |
 
@@ -291,7 +336,7 @@ export const MyCollection: SanitizedCollectionConfig = {
   admin: {
     components: {
       views: {
-        Edit: {
+        Edit: { // You can also define `components.views.Edit` as a component, this will override _all_ nested views
           Default: MyCustomDefaultTab,
           Versions: MyCustomVersionsTab,
           Version: MyCustomVersionTab,
@@ -304,7 +349,7 @@ export const MyCollection: SanitizedCollectionConfig = {
 }
 ```
 
-To add a _new_ tab to the `Edit` view, simply add another key to the `views.Edit` object with at least a `path` and `Component` property. For example:
+To add a _new_ tab to the `Edit` view, simply add another key to `components.views.Edit[key]` with at least a `path` and `Component` property. For example:
 
 ```ts
 // `Collection.ts` or `Global.ts`
@@ -317,6 +362,17 @@ export const MyCollection: SanitizedCollectionConfig = {
           MyCustomTab: {
             Component: MyCustomTab,
             path: '/my-custom-tab',
+            // You an swap the entire tab component out for your own
+            Tab: MyCustomTab
+          },
+          AnotherCustomView: {
+            Component: AnotherCustomView,
+            path: '/another-custom-view',
+            // Or you can use the default tab component and just pass in your own label and href
+            Tab: {
+              label: 'Another Custom View',
+              href: '/another-custom-view',
+            }
           },
         },
       },
@@ -343,12 +399,12 @@ Your custom view components will be given all the props that a React Router `<Ro
 
 #### Example
 
-You can find examples of custom views in the [Payload source code `/test/admin/components/views` folder](https://github.com/payloadcms/payload/tree/master/test/admin/components/views). There, you'll find two custom views:
+You can find examples of custom views in the [Payload source code `/test/admin/components/views` folder](https://github.com/payloadcms/payload/tree/main/test/admin/components/views). There, you'll find two custom views:
 
 1. A custom view that uses the `DefaultTemplate`, which is the built-in Payload template that displays the sidebar and "eyebrow nav"
 1. A custom view that uses the `MinimalTemplate` - which is just a centered template used for things like logging in or out
 
-To see how to pass in your custom views to create custom views of your own, take a look at the `admin.components.views` property of the [Payload test admin config](https://github.com/payloadcms/payload/blob/master/test/admin/config.ts).
+To see how to pass in your custom views to create custom views of your own, take a look at the `admin.components.views` property of the [Payload test admin config](https://github.com/payloadcms/payload/blob/main/test/admin/config.ts).
 
 ### Fields
 

docs/admin/environment-vars.mdx

@@ -5,8 +5,6 @@ order: 100
 desc: NEEDS TO BE WRITTEN
 ---
 
-TODO: expand on this and make sure it looks nice, talk about how if you use a `process.env.SERVER_URL`, it might not be usable in your Payload config in your admin UI, but it needs to be, so it should be prefixed like `process.env.PAYLOAD_PUBLIC_SERVER_URL` to work in both places
-
 ## Admin environment vars
 
 <Banner type="warning">

docs/admin/excluding-server-code.mdx

@@ -5,18 +5,16 @@ order: 70
 desc: Learn how to exclude server-only code from the Payload Admin UI bundle
 ---
 
-### Aliasing server-only modules
-
 Because the Admin Panel browser bundle includes your Payload Config file, files using server-only modules need to be excluded.
 It's common for your config to rely on server only modules to perform logic in access control functions, hooks, and other contexts.
 
 Any file that imports a server-only module such as `fs`, `stripe`, `authorizenet`, `nodemailer`, etc. **cannot** be included in the browser bundle.
 
-#### Let's Look at an example
+#### Example Scenario
 
 Say we have a collection called `Subscriptions` that has a `beforeChange` hook that creates a Stripe subscription whenever a Subscription document is created in Payload.
 
-##### Your collection config
+**Collection config**:
 
 ```ts
 // collections/Subscriptions/index.ts
@@ -39,7 +37,7 @@ export const Subscription: CollectionConfig = {
 }
 ```
 
-##### Your collection hook
+**Collection hook**:
 
 ```ts
 // collections/Subscriptions/hooks/createStripeSubscription.ts
@@ -83,7 +81,7 @@ export const createStripeSubscription = async ({ data, operation }) => {
 
 #### How to fix this
 
-You need to make sure that you use `alias`es to tell your bundler to import "safe" files vs. attempting to import any server-side code that you need to get rid of. Depending on your bundler (Webpack, Vite, etc.) the steps involved may be slightly different. 
+You need to make sure that you use `alias`es to tell your bundler to import "safe" files vs. attempting to import any server-side code that you need to get rid of. Depending on your bundler (Webpack, Vite, etc.) the steps involved may be slightly different.
 
 The basic idea is to create a file that exports an empty object, and then alias import paths of any files that import server-only modules to that empty object file.
 

docs/admin/hooks.mdx

@@ -347,7 +347,7 @@ The `useForm` hook returns an object with the following properties: |
           value: <strong><code>rowIndex</code></strong>,
         },
         {
-          value: "The index of the row to add",
+          value: "The index of the row to add. If omitted, the row will be added to the end of the array.",
         },
       ],
       [

docs/admin/overview.mdx

@@ -28,25 +28,25 @@ When bundled, it is code-split, highly performant (even with 100+ fields), and w
 
 All options for the Admin panel are defined in your base Payload config file.
 
-| Option                | Description                                                                                                                                                                                                                                                  |
-| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `user`                | The `slug` of a Collection that you want be used to log in to the Admin dashboard. [More](/docs/admin/overview#the-admin-user-collection)                                                                                                                    |
-| `buildPath`           | Specify an absolute path for where to store the built Admin panel bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                                                                                                             |
-| `meta`                | Base meta data to use for the Admin panel. Included properties are `titleSuffix`, `ogImage`, and `favicon`.                                                                                                                                                  |
-| `disable`             | If set to `true`, the entire Admin panel will be disabled.                                                                                                                                                                                                   |
-| `indexHTML`           | Optionally replace the entirety of the `index.html` file used by the Admin panel. Reference the [base index.html file](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/index.html) to ensure your replacement has the appropriate HTML elements. |
-| `css`                 | Absolute path to a stylesheet that you can use to override / customize the Admin panel styling. [More](/docs/admin/customizing-css).                                                                                                                         |
-| `scss`                | Absolute path to a Sass variables / mixins stylesheet meant to override Payload styles to make for an easy re-skinning of the Admin panel. [More](/docs/admin/customizing-css#overriding-scss-variables).                                                    |
-| `dateFormat`          | Global date format that will be used for all dates in the Admin panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                                                                                                               |
-| `avatar`              | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                                                                                                                     |
-| `autoLogin`           | Used to automate admin log-in for dev and demonstration convenience. [More](/docs/authentication/config).                                                                                                                                                    |
-| `livePreview`         | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).                                                                                                                                     |
-| `components`          | Component overrides that affect the entirety of the Admin panel. [More](/docs/admin/components)                                                                                                                                                              |
-| `webpack`             | Customize the Webpack config that's used to generate the Admin panel. [More](/docs/admin/webpack)                                                                                                                                                            |
-| `vite`                | Customize the Vite config that's used to generate the Admin panel. [More](/docs/admin/vite)                                                                                                                                                                  |
-| **`bundler`**         | The bundler that you would like to use to bundle the admin panel. Officially supported bundlers: [Webpack](/docs/admin/webpack) and [Vite](/docs/admin/vite).                                                                                                |
-| **`logoutRoute`**     | The route for the `logout` page.                                                                                                                                                                                                                             |
-| **`inactivityRoute`** | The route for the `logout` inactivity page.                                                                                                                                                                                                                  |
+| Option            | Description                                                                                                                                                                                                                                                                 |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bundler`         | The bundler that you would like to use to bundle the admin panel. Officially supported bundlers: [Webpack](/docs/admin/webpack) and [Vite](/docs/admin/vite).                                                                                                               |
+| `user`            | The `slug` of a Collection that you want be used to log in to the Admin dashboard. [More](/docs/admin/overview#the-admin-user-collection)                                                                                                                                   |
+| `buildPath`       | Specify an absolute path for where to store the built Admin panel bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                                                                                                                            |
+| `meta`            | Base meta data to use for the Admin panel. Included properties are `titleSuffix`, `ogImage`, and `favicon`.                                                                                                                                                                 |
+| `disable`         | If set to `true`, the entire Admin panel will be disabled.                                                                                                                                                                                                                  |
+| `indexHTML`       | Optionally replace the entirety of the `index.html` file used by the Admin panel. Reference the [base index.html file](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/index.html) to ensure your replacement has the appropriate HTML elements. |
+| `css`             | Absolute path to a stylesheet that you can use to override / customize the Admin panel styling. [More](/docs/admin/customizing-css).                                                                                                                                        |
+| `scss`            | Absolute path to a Sass variables / mixins stylesheet meant to override Payload styles to make for an easy re-skinning of the Admin panel. [More](/docs/admin/customizing-css#overriding-scss-variables).                                                                   |
+| `dateFormat`      | Global date format that will be used for all dates in the Admin panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                                                                                                                              |
+| `avatar`          | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                                                                                                                                    |
+| `autoLogin`       | Used to automate admin log-in for dev and demonstration convenience. [More](/docs/authentication/config).                                                                                                                                                                   |
+| `livePreview`     | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).                                                                                                                                                    |
+| `components`      | Component overrides that affect the entirety of the Admin panel. [More](/docs/admin/components)                                                                                                                                                                             |
+| `webpack`         | Customize the Webpack config that's used to generate the Admin panel. [More](/docs/admin/webpack)                                                                                                                                                                           |
+| `vite`            | Customize the Vite config that's used to generate the Admin panel. [More](/docs/admin/vite)                                                                                                                                                                                 |
+| `logoutRoute`     | The route for the `logout` page.                                                                                                                                                                                                                                            |
+| `inactivityRoute` | The route for the `logout` inactivity page.                                                                                                                                                                                                                                 |
 
 ### The Admin User Collection
 

docs/configuration/collections.mdx

@@ -29,7 +29,6 @@ It's often best practice to write your Collections in separate files and then im
 | **`graphQL`**     | An object with `singularName` and `pluralName` strings used in schema generation. Auto-generated from slug if not defined. Set to `false` to disable GraphQL.                                                            |
 | **`typescript`**  | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                      |
 | **`defaultSort`** | Pass a top-level field to sort by default in the collection List view. Prefix the name of the field with a minus symbol ("-") to sort in descending order.                                                               |
-| **`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._
@@ -84,6 +83,7 @@ property on a collection's config.
 | `livePreview`                | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).                                                                              |
 | `components`                 | Swap in your own React components to be used within this collection. [More](/docs/admin/components#collections)                                                                                       |
 | `listSearchableFields`       | Specify which fields should be searched in the List search view. [More](#list-searchable-fields)                                                                                                      |
+| **`pagination`**             | Set pagination-specific options for this collection. [More](#pagination)                                                                                                                              |
 
 ### Preview
 

docs/configuration/i18n.mdx

@@ -65,7 +65,7 @@ After a user logs in, they can change their language selection in the `/account`
   <strong>Note:</strong>
   <br />
   If there is a language that Payload does not yet support, we accept code
-  [contributions](https://github.com/payloadcms/payload/blob/main/contributing.md).
+  [contributions](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md).
 </Banner>
 
 ### Node Express

docs/configuration/overview.mdx

@@ -19,48 +19,53 @@ Payload is a _config-based_, code-first CMS and application framework. The Paylo
 
 ## 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).                 |
-| `editor`              | Default richText editor which will be used by richText fields.                                                                                                                |
-| `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)                                                                                                                     |
+| Option                | Description                                                                                                                                                                       |
+| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `admin` \*            | Base Payload admin configuration. Specify bundler*, custom components, control metadata, set the Admin user collection, and [more](/docs/admin/overview#admin-options). Required. |
+| `editor` \*           | Rich Text Editor which will be used by richText fields. Required.                                                                                                                 |
+| `db` \*               | Database Adapter which will be used by Payload. Read more [here](/docs/database/overview). Required.                                                                              |
+| `serverURL`           | A string used to define the absolute URL of your app including the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port     |
+| `collections`         | An array of all Collections that Payload will manage. To read more about how to define your collection configs, [click here](/docs/configuration/collections).                    |
+| `globals`             | An array of all Globals that Payload will manage. For more on Globals and their configs, [click here](/docs/configuration/globals).                                               |
+| `cors`                | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain.                                           |
+| `localization`        | Opt-in and control how Payload handles the translation of your content into multiple locales. [More](/docs/configuration/localization)                                            |
+| `graphQL`             | Manage GraphQL-specific functionality here. Define your own queries and mutations, manage query complexity limits, and [more](/docs/graphql/overview#graphql-options).            |
+| `cookiePrefix`        | A string that will be prefixed to all cookies that Payload sets.                                                                                                                  |
+| `csrf`                | A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. [More](/docs/authentication/overview#csrf-protection)                        |
+| `defaultDepth`        | If a user does not specify `depth` while requesting a resource, this depth will be used. [More](/docs/getting-started/concepts#depth)                                             |
+| `maxDepth`            | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`.                                               |
+| `indexSortableFields` | Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar.                        |
+| `upload`              | Base Payload upload configuration. [More](/docs/upload/overview#payload-wide-upload-options).                                                                                     |
+| `routes`              | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`.                                                           |
+| `email`               | Base email settings to allow Payload to generate email such as Forgot Password requests and other requirements. [More](/docs/email/overview#configuration)                        |
+| `express`             | Express-specific middleware options such as compression and JSON parsing. [More](/docs/configuration/express)                                                                     |
+| `debug`               | Enable to expose more detailed error information.                                                                                                                                 |
+| `telemetry`           | Disable Payload telemetry by passing `false`. [More](/docs/configuration/overview#telemetry)                                                                                      |
+| `rateLimit`           | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks and [more](/docs/production/preventing-abuse#rate-limiting-requests).                      |
+| `hooks`               | Tap into Payload-wide hooks. [More](/docs/hooks/overview)                                                                                                                         |
+| `plugins`             | An array of Payload plugins. [More](/docs/plugins/overview)                                                                                                                       |
+| `endpoints`           | An array of custom API endpoints added to the Payload router. [More](/docs/rest-api/overview#custom-endpoints)                                                                    |
+| `custom`              | Extension point for adding custom data (e.g. for plugins)                                                                                                                         |
+
+_\* An asterisk denotes that a property is required._
 
 #### Simple example
 
 ```ts
 import { buildConfig } from 'payload/config'
 import { mongooseAdapter } from '@payloadcms/db-mongodb'
-import { postgresAdapter } from '@payloadcms/db-postgres'
+import { postgresAdapter } from '@payloadcms/db-postgres' // beta
 
 import { viteBundler } from '@payloadcms/bundler-vite'
 import { webpackBundler } from '@payloadcms/bundler-webpack'
 
-import { lexicalEditor } from '@payloadcms/richtext-lexical'
+import { lexicalEditor } from '@payloadcms/richtext-lexical' // beta
 import { slateEditor } from '@payloadcms/richtext-slate'
 
 export default buildConfig({
-  bundler: webpackBundler() // or viteBundler(),
+  admin: {
+    bundler: webpackBundler(), // or viteBundler()
+  },
   db: mongooseAdapter({}) // or postgresAdapter({}),
   editor: lexicalEditor({}) // or slateEditor({})
   collections: [

docs/database/migrations.mdx

@@ -6,10 +6,18 @@ keywords: database, migrations, ddl, sql, mongodb, postgres, documentation, Cont
 desc: Payload features first-party database migrations all done in TypeScript.
 ---
 
-## Migrations
-
 Payload exposes a full suite of migration controls available for your use. Migration commands are accessible via the `npm run payload` command in your project directory.
 
+Ensure you have an npm script called "payload" in your `package.json` file.
+
+```json
+{
+  "scripts": {
+    "payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload"
+  }
+}
+```
+
 <Banner>
   Note that you need to run Payload migrations through the package manager that you are using, because Payload should not be globally installed on your system.
 </Banner>
@@ -38,7 +46,7 @@ export async function down({ payload }: MigrateDownArgs): Promise<void> {
 };
 ```
 
-All database adapters should implement similar migration patterns, but there will be small differences based on the adapter and its specific needs. Below is a list of all migration commands that should be supported by your database adapter. 
+All database adapters should implement similar migration patterns, but there will be small differences based on the adapter and its specific needs. Below is a list of all migration commands that should be supported by your database adapter.
 
 ### Migrate
 
@@ -92,7 +100,7 @@ npm run payload migrate:reset
 
 ### Fresh
 
-Drops all entities from the database and re-runs all migrations from scratch. 
+Drops all entities from the database and re-runs all migrations from scratch.
 
 ```text
 npm run payload migrate:fresh

docs/getting-started/installation.mdx

@@ -11,8 +11,8 @@ keywords: documentation, getting started, guide, Content Management System, cms,
 Payload requires the following software:
 
 - Yarn or NPM
-- Node.js version 14+
-- A Database (MongoDB or Postgres)
+- Node.js version 16+
+- Any [compatible database](/docs/database/overview) (MongoDB or Postgres)
 
 <Banner type="warning">
   Before proceeding any further, please ensure that you have the above requirements met.
@@ -104,43 +104,43 @@ PAYLOAD_SECRET=your-payload-secret
 
 Here is a list of all properties available to pass through `payload.init`:
 
-##### `secret`
+##### 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.
 
 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.
 
-##### `config`
+##### config
 
 Allows you to pass your config directly to the onInit function. The config passed here should match the payload.config file.
 
-##### `disableOnInit`
+##### disableOnInit
 
 A boolean that disables running your `onInit` function when Payload starts up.
 
-##### `disableDBConnect`
+##### disableDBConnect
 
 A boolean that disables the database connection when Payload starts up.
 
-##### `email`
+##### email
 
 An object used to configure SMTP. [Read more](/docs/email/overview).
 
-##### `express`
+##### express
 This is your Express app as shown above. Payload will tie into your existing `app` and scope all of its functionalities to sub-routers. By default, Payload will add an `/admin` router and an `/api` router, but you can customize these paths.
 
-##### `local`
+##### local
 
 A boolean that when set to `true` tells Payload to start in local-only mode which will bypass setting up API routes. When set to `true`, `express` is not required. This is useful when running scripts that need to use Payload's [local-api](/docs/local-api/overview).
 
-##### `loggerDestination`
+##### loggerDestination
 
 Specify destination stream for the built-in Pino logger that Payload uses for internal logging. See [Pino Docs](https://getpino.io/#/docs/api?id=pino-destination) for more info on what is available.
 
-##### `loggerOptions`
+##### loggerOptions
 
 Specify options for the built-in Pino logger that Payload uses for internal logging. See [Pino Docs](https://getpino.io/#/docs/api?id=options) for more info on what is available.
 
-##### `onInit`
+##### onInit
 
 A function that is called immediately following startup that receives the Payload instance as it's only argument.
 

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.
 
-### Schema generatation script
+### Schema generation script
 
 Run the following command in a Payload project to generate your project's GraphQL schema from Payload:
 

docs/live-preview/frontend.mdx

@@ -88,13 +88,14 @@ This package provides the following functions:
 | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`subscribe`**       | Subscribes to the Admin panel's `window.postMessage` events and calls the provided callback function.                                                                                       |
 | **`unsubscribe`**     | Unsubscribes from the Admin panel's `window.postMessage` events.                                                                                                                            |
+| **`ready`**           | Sends a `window.postMessage` event to the Admin panel to indicate that the front-end is ready to receive messages.                                                                          |
 
 The `subscribe` function takes the following args:
 
 | Path                  | Description                                                                                                                                                                                 |
 | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`callback`** \*     | A callback function that is called with `data` every time a change is made to the document.                                                                                                 |
-| **`serverURL`** \*    | The URL of your Payload server.                                                                                                                                                        git s     |
+| **`serverURL`** \*    | The URL of your Payload server.                                                                                                                                                             |
 | **`initialData`**     | The initial data of the document. The live data will be merged in as changes are made.                                                                                                      |
 | **`depth`**           | The depth of the relationships to fetch. Defaults to `0`.                                                                                                                                   |
 
@@ -103,18 +104,23 @@ With these functions, you can build your own hook using your front-end framework
 ```tsx
 import { subscribe, unsubscribe } from '@payloadcms/live-preview';
 
-// Build your own hook to subscribe to the live preview events
-// This function will handle everything for you like
-// 1. subscribing to `window.postMessage` events
-// 2. merging initial page data with incoming form state
-// 3. populating relationships and uploads
+// To build your own hook, subscribe to Live Preview events using the`subscribe` function
+// It handles everything from:
+// 1. Listening to `window.postMessage` events
+// 2. Merging initial data with active form state
+// 3. Populating relationships and uploads
+// 4. Calling the `onChange` callback with the result
+// Your hook should also:
+// 1. Tell the Admin panel when it is ready to receive messages
+// 2. Handle the results of the `onChange` callback to update the UI
+// 3. Unsubscribe from the `window.postMessage` events when it unmounts
 ```
 
 Here is an example of what the same `useLivePreview` React hook from above looks like under the hood:
 
 ```tsx
-import { subscribe, unsubscribe } from '@payloadcms/live-preview'
-import { useCallback, useEffect, useState } from 'react'
+import { subscribe, unsubscribe, ready } from '@payloadcms/live-preview'
+import { useCallback, useEffect, useState, useRef } from 'react'
 
 export const useLivePreview = <T extends any>(props: {
   depth?: number
@@ -127,13 +133,18 @@ export const useLivePreview = <T extends any>(props: {
   const { depth = 0, initialData, serverURL } = props
   const [data, setData] = useState<T>(initialData)
   const [isLoading, setIsLoading] = useState<boolean>(true)
+  const hasSentReadyMessage = useRef<boolean>(false)
 
   const onChange = useCallback((mergedData) => {
+    // When a change is made, the `onChange` callback will be called with the merged data
+    // Set this merged data into state so that React will re-render the UI
     setData(mergedData)
     setIsLoading(false)
   }, [])
 
   useEffect(() => {
+    // Listen for `window.postMessage` events from the Admin panel
+    // When a change is made, the `onChange` callback will be called with the merged data
     const subscription = subscribe({
       callback: onChange,
       depth,
@@ -141,6 +152,17 @@ export const useLivePreview = <T extends any>(props: {
       serverURL,
     })
 
+    // Once subscribed, send a `ready` message back up to the Admin panel
+    // This will indicate that the front-end is ready to receive messages
+    if (!hasSentReadyMessage.current) {
+      hasSentReadyMessage.current = true
+
+      ready({
+        serverURL
+      })
+    }
+
+    // When the component unmounts, unsubscribe from the `window.postMessage` events
     return () => {
       unsubscribe(subscription)
     }

docs/live-preview/overview.mdx

@@ -8,7 +8,7 @@ keywords: live preview, preview, live, iframe, iframe preview, visual editing, d
 
 **With Live Preview you can render your front-end application directly within the Admin panel. As you type, your changes take effect in real-time. No need to save a draft or publish your changes.**
 
-Live Preview works by rendering an iframe on the page that loads your front-end application. The Admin panel communicates with your app through `window.postMessage` events. These events are emitted every time a change is made to the document. Your app then listens for these events and re-renders itself with the data it receives.
+Live Preview works by rendering an iframe on the page that loads your front-end application. The Admin panel communicates with your app through [`window.postMessage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) events. These events are emitted every time a change is made to the document. Your app then listens for these events and re-renders itself with the data it receives.
 
 {/* IMAGE OF LIVE PREVIEW HERE */}
 
@@ -84,8 +84,8 @@ Here is an example of using a function that returns a dynamic URL:
         documentInfo,
         locale
       }) => `${data.tenant.url}${ // Multi-tenant top-level domain
-        documentInfo.slug === 'posts' ? `/posts/${data.slug}` : `/${data.slug}
-      `}?locale=${locale}`, // Localization query param
+        documentInfo.slug === 'posts' ? `/posts/${data.slug}` : `${data.slug !== 'home' : `/${data.slug}` : ''}`
+      }${locale ? `?locale=${locale?.code}` : ''}`, // Localization query param
       collections: ['pages'],
     },
   }

docs/local-api/overview.mdx

@@ -131,6 +131,7 @@ const result = await payload.find({
   depth: 2,
   page: 1,
   limit: 10,
+  pagination: false, // If you want to disable pagination count, etc.
   where: {}, // pass a `where` query here
   sort: '-title',
   locale: 'en',
@@ -412,7 +413,7 @@ dotenv.config({
   path: path.resolve(__dirname, '../.env'),
 })
 
-const { PAYLOAD_SECRET, MONGODB_URI } = process.env
+const { PAYLOAD_SECRET } = process.env
 
 const doAction = async (): Promise<void> => {
   await payload.init({

docs/plugins/admin-compatibility.mdx

@@ -1,10 +1,10 @@
 ---
 title: Admin panel compatibility
 label: Admin compatibility
-order: 20
+order: 30
 desc: NEEDS TO BE WRITTEN
 ---
 
-TODO: talk about how plugins need to ensure compatibility with both Vite and Webpack
-
-- It's best practice to alias your plugin to an admin-only version, so if you have admin-only changes, put them in the admin plugin, and then leave the full plugin, complete with server code, to be installed on the server side
+<Banner type="success">
+  COMING SOON: This page is a work in progress. Check back soon for more information.
+</Banner>

docs/plugins/build-your-own.mdx

@@ -0,0 +1,294 @@
+---
+title: Building Your Own Plugin
+label: Build Your Own
+order: 20
+desc: Starting to build your own plugin? Find everything you need and learn best practices with the Payload plugin template.
+keywords: plugins, template, config, configuration, extensions, custom, documentation, Content Management System, cms, headless, javascript, node, react, express
+---
+
+Building your own plugin is easy, and if you're already familiar with Payload then you'll have everything you need to get started. You can either start from scratch or use the Payload plugin template to get up and running quickly.
+
+<Banner type="success">
+  To use the template, run `npx create-payload-app@latest -t plugin -n my-new-plugin` directly in your terminal or [clone the template directly from GitHub](https://github.com/payloadcms/payload-plugin-template).
+</Banner>
+
+Our plugin template includes everything you need to build a full life-cycle plugin:
+
+* Example files and functions for extending the payload config
+* A local dev environment to develop the plugin
+* Test suite with integrated GitHub workflow
+
+By abstracting your code into a plugin, you&apos;ll be able to reuse your feature across multiple projects and make it available for other developers to use.
+
+### Plugins Recap
+
+Here is a brief recap of how to integrate plugins with Payload, to learn more head back to the [plugin overview page](https://payloadcms.com/docs/plugins/overview).
+
+
+#### How to install a plugin
+
+To install any plugin, simply add it to your Payload config in the plugins array.
+
+```
+import samplePlugin from 'sample-plugin';
+
+const config = buildConfig({
+  plugins: [
+    // Add plugins here
+    samplePlugin({
+		enabled: true,
+    }),
+  ],
+});
+
+export default config;
+```
+
+
+#### Initialization
+
+The initialization process goes in the following order:
+
+1. Incoming config is validated
+2. Plugins execute
+3. Default options are integrated
+4. Sanitization cleans and validates data
+5. Final config gets initialized
+
+
+### Plugin Template
+
+In the [Payload plugin template](https://github.com/payloadcms/payload-plugin-template), you will see a common file structure that is used across plugins:
+
+1. root folder - general configuration
+2. /src folder - everything related to the plugin
+3. /dev folder - sanitized test project for development
+
+
+#### Root
+
+In the root folder, you will see various files related to the configuration of the plugin. We set up our environment in a similar manner in Payload core and across other projects. The only two files you need to modify are:
+
+* **README**.md - This contains instructions on how to use the template. When you are ready, update this to contain instructions on how to use your Plugin.
+* **package**.json - Contains necessary scripts and dependencies. Overwrite the metadata in this file to describe your Plugin.
+
+
+#### Dev
+
+The purpose of the **dev** folder is to provide a sanitized local Payload project. so you can run and test your plugin while you are actively developing it.
+
+Do **not** store any of the plugin functionality in this folder - it is purely an environment to _assist_ you with developing the plugin.
+
+If you&apos;re starting from scratch, you can easily setup a dev environment like this:
+
+```
+mkdir dev
+cd dev
+npx create-payload-app
+```
+
+If you&apos;re using the plugin template, the dev folder is built out for you and the `samplePlugin` has already been installed in `dev/payload.config()`.
+
+```
+  plugins: [
+    // when you rename the plugin or add options, make sure to update it here
+    samplePlugin({
+      enabled: false,
+    })
+  ]
+```
+
+You can add to the `dev/payload.config` and build out the dev project as needed to test your plugin.
+
+When you&apos;re ready to start development, navigate into this folder with `cd dev`
+
+And then start the project with `yarn dev` and pull up `http://localhost:3000` in your browser.
+
+
+### Testing
+
+Another benefit of the dev folder is that you have the perfect environment established for testing.
+
+A good test suite is essential to ensure quality and stability in your plugin. Payload typically uses [Jest](https://jestjs.io/); a popular testing framework, widely used for testing JavaScript and particularly for applications built with React.
+
+Jest organizes tests into test suites and cases. We recommend creating tests based on the expected behavior of your plugin from start to finish. Read more about tests in the [Jest documentation.](https://jestjs.io/)
+
+The plugin template provides a stubbed out test suite at `dev/plugin.spec.ts` which is ready to go - just add in your own test conditions and you&apos;re all set!
+
+```
+import payload from 'payload'
+
+describe('Plugin tests', () => {
+  // Example test to check for seeded data
+  it('seeds data accordingly', async () => {
+    const newCollectionQuery = await payload.find({
+      collection: 'newCollection',
+      sort: 'createdAt',
+    })
+
+    newCollection = newCollectionQuery.docs
+
+    expect(newCollectionQuery.totalDocs).toEqual(1)
+  })
+})
+```
+
+
+### Seeding data
+
+For development and testing, you will likely need some data to work with. You can streamline this process by seeding and dropping your database - instead of manually entering data.
+
+In the plugin template, you can navigate to `dev/src/server.ts` and see an example seed function.
+
+```
+if (process.env.PAYLOAD_SEED === 'true') {
+    await seed(payload)
+}
+```
+
+A sample seed function has been created for you at `dev/src/seed`, update this file with additional data as needed.
+
+```
+export const seed = async (payload: Payload): Promise<void> => {
+  payload.logger.info('Seeding data...')
+
+  await payload.create({
+    collection: 'new-collection',
+    data: {
+      title: 'Seeded title',
+    },
+  })
+
+  // Add additional seed data here
+}
+
+```
+
+
+#### Src
+
+Now that we have our environment setup and dev project ready to go - it&apos;s time to build the plugin!
+
+
+**index.ts**
+
+First up, the `src/index.ts` file - this is where the plugin should be imported from. It is best practice not to build the plugin directly in this file, instead we use this to export the plugin and types from their respective files.
+
+
+**Plugin.ts**
+
+To reiterate, the essence of a payload plugin is simply to extend the Payload config - and that is exactly what we are doing in this file.
+
+```
+export const samplePlugin =
+  (pluginOptions: PluginTypes) =>
+  (incomingConfig: Config): Config => {
+    let config = { ...incomingConfig }
+
+   // do something cool with the config here
+
+    return config
+ }
+```
+
+1. First, you need to receive the existing Payload config along with any plugin options.
+2. Then set the variable `config` to be equal to a copy of the existing config.
+3. From here, you can extend the config however you like!
+4. Finally, return the config and you&apos;re all set.
+
+
+### Spread Syntax
+
+[Spread syntax](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax) (or the spread operator) is a feature in JavaScript that uses the dot notation **(...)** to spread elements from arrays, strings, or objects into various contexts.
+
+We are going to use spread syntax to allow us to add data to existing arrays without losing the existing data. It is crucial to spread the existing data correctly, else this can cause adverse behavior and conflicts with Payload config and other plugins.
+
+Let&apos;s say you want to build a plugin that adds a new collection:
+
+```
+config.collections = [
+  ...(config.collections || []),
+ newCollection,
+  // Add additional collections here
+]
+```
+
+First, you need to spread the `config.collections` to ensure that we don&apos;t lose the existing collections. Then you can add any additional collections, just as you would in a regular payload config.
+
+This same logic is applied to other properties like admin, globals, hooks:
+
+```
+config.globals = [
+  ...(config.globals || []),
+  // Add additional globals here
+]
+
+config.hooks = {
+  ...(config.hooks || {}),
+  // Add additional hooks here
+}
+```
+
+Some properties will be slightly different to extend, for instance the `onInit` property:
+
+```
+config.onInit = async payload => {
+  if (incomingConfig.onInit) await incomingConfig.onInit(payload)
+
+  // Add additional onInit code by using the onInitExtension function
+  onInitExtension(pluginOptions, payload)
+}
+```
+
+If you wish to add to the `onInit`, you must include the async/await. We don&apos;t use spread syntax in this case, instead you must await the existing `onInit` before running additional functionality.
+
+In the template, we have stubbed out a basic `onInitExtension` file that you can use, if not needed feel free to delete it.
+
+
+### Webpack
+
+If any of your files use server only packages such as fs, stripe, nodemailer, etc, they will need to be removed from the browser bundle. To do that, you can [alias the file imports with webpack](https://payloadcms.com/docs/admin/webpack#aliasing-server-only-modules).
+
+When files are bundled for the browser, the import paths are essentially crawled to determine what files to include in the bundle. To prevent the server only files from making it into the bundle, we can alias their import paths to a file that can be included in the browser. This will short-circuit the import path crawling and ensure browser only code is bundled.
+
+Webpack is another part of the Payload config that can be a little more tricky to extend. To help here, the template includes a helper function `extendWebpackConfig()` which takes care of spreading the existing webpack, so you can just add your new stuff:
+
+```
+config.admin = {
+  ...(config.admin || {}),
+  // Add your aliases to the helper function below
+  webpack: extendWebpackConfig(incomingConfig)
+}
+```
+
+### Types
+
+If your plugin has options, you should define and provide types for these options in a separate file which gets exported from the main `index.ts`.
+
+```
+export interface PluginTypes {
+  /**
+   * Enable or disable plugin
+   * @default false
+   */
+  enabled?: boolean
+}
+
+```
+
+If possible, include [JSDoc comments](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#types-1) to describe the options and their types. This allows a developer to see details about the options in their editor.
+
+### Best practices
+
+In addition to the setup covered above, here are other best practices to follow:
+
+##### Providing an enable / disable option:
+For a better user experience, provide a way to disable the plugin without uninstalling it. This is especially important if your plugin adds additional webpack aliases, this will allow you to still let the webpack run to prevent errors.
+##### Include tests in your GitHub CI workflow:
+If you&apos;ve configured tests for your package, integrate them into your workflow to run the tests each time you commit to the plugin repository. Learn more about [how to configure tests into your GitHub CI workflow.](https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs)
+##### Publish your finished plugin to NPM:
+The best way to share and allow others to use your plugin once it is complete is to publish an NPM package. This process is straightforward and well documented, find out more about [creating and publishing a NPM package here](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages/).
+##### Add payload-plugin topic tag:
+Apply the tag **payload-plugin** to your GitHub repository. This will boost the visibility of your plugin and ensure it gets listed with [existing payload plugins](https://github.com/topics/payload-plugin).
+##### Use [Semantic Versioning](https://semver.org/) (SemVar):
+With the SemVar system you release version numbers that reflect the nature of changes (major, minor, patch). Ensure all major versions reference their Payload compatibility.

docs/production/deployment.mdx

@@ -160,7 +160,7 @@ DigitalOcean provides extremely helpful documentation that can walk you through
 
 ## 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.
+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 `DATABASE_URI` if needed.
 
 ```dockerfile
 FROM node:18-alpine as base
@@ -210,7 +210,7 @@ services:
     depends_on:
       - mongo
     environment:
-      MONGODB_URI: mongodb://mongo:27017/payload
+      DATABASE_URI: mongodb://mongo:27017/payload
       PORT: 3000
       NODE_ENV: development
       PAYLOAD_SECRET: TESTING

docs/queries/pagination.mdx

@@ -59,3 +59,7 @@ All Payload APIs support the pagination controls below. With them, you can creat
 | ------- | --------------------------------------- |
 | `limit` | Limits the number of documents returned |
 | `page`  | Get a specific page number              |
+
+### Disabling pagination within Local API
+
+For `find` operations within the Local API, you can disable pagination to retrieve all documents from a collection by passing `pagination: false` to the `find` local operation. This is not supported in REST or GraphQL, however, because it could potentially lead to malicious activity.

examples/auth/next-app/.env.example

@@ -1 +1 @@
-NEXT_PUBLIC_CMS_URL=http://localhost:3000
+NEXT_PUBLIC_PAYLOAD_URL=http://localhost:3000

examples/auth/next-app/app/_providers/Auth/gql.ts

@@ -8,7 +8,7 @@ export const USER = `
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const gql = async (query: string): Promise<any> => {
   try {
-    const res = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/graphql`, {
+    const res = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/graphql`, {
       method: 'POST',
       credentials: 'include',
       headers: {

examples/auth/next-app/app/_providers/Auth/index.tsx

@@ -18,7 +18,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
   const create = useCallback<Create>(
     async args => {
       if (api === 'rest') {
-        const user = await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users`, args)
+        const user = await rest(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users`, args)
         setUser(user)
         return user
       }
@@ -40,7 +40,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
   const login = useCallback<Login>(
     async args => {
       if (api === 'rest') {
-        const user = await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/login`, args)
+        const user = await rest(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/login`, args)
         setUser(user)
         return user
       }
@@ -64,7 +64,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
 
   const logout = useCallback<Logout>(async () => {
     if (api === 'rest') {
-      await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/logout`)
+      await rest(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/logout`)
       setUser(null)
       return
     }
@@ -83,7 +83,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
     const fetchMe = async () => {
       if (api === 'rest') {
         const user = await rest(
-          `${process.env.NEXT_PUBLIC_CMS_URL}/api/users/me`,
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/me`,
           {},
           {
             method: 'GET',
@@ -113,7 +113,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
     async args => {
       if (api === 'rest') {
         const user = await rest(
-          `${process.env.NEXT_PUBLIC_CMS_URL}/api/users/forgot-password`,
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/forgot-password`,
           args,
         )
         setUser(user)
@@ -134,7 +134,10 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
   const resetPassword = useCallback<ResetPassword>(
     async args => {
       if (api === 'rest') {
-        const user = await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/reset-password`, args)
+        const user = await rest(
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/reset-password`,
+          args,
+        )
         setUser(user)
         return user
       }

examples/auth/next-app/app/_utilities/getMeUser.ts

@@ -14,7 +14,7 @@ export const getMeUser = async (args?: {
   const cookieStore = cookies()
   const token = cookieStore.get('payload-token')?.value
 
-  const meUserReq = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/me`, {
+  const meUserReq = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/me`, {
     headers: {
       Authorization: `JWT ${token}`,
     },

examples/auth/next-app/app/account/AccountForm/index.tsx

@@ -39,15 +39,18 @@ export const AccountForm: React.FC = () => {
   const onSubmit = useCallback(
     async (data: FormData) => {
       if (user) {
-        const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/${user.id}`, {
-          // Make sure to include cookies with fetch
-          credentials: 'include',
-          method: 'PATCH',
-          body: JSON.stringify(data),
-          headers: {
-            'Content-Type': 'application/json',
+        const response = await fetch(
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/${user.id}`,
+          {
+            // Make sure to include cookies with fetch
+            credentials: 'include',
+            method: 'PATCH',
+            body: JSON.stringify(data),
+            headers: {
+              'Content-Type': 'application/json',
+            },
           },
-        })
+        )
 
         if (response.ok) {
           const json = await response.json()

examples/auth/next-app/app/account/page.tsx

@@ -22,7 +22,7 @@ export default async function Account() {
       <h1>Account</h1>
       <p>
         {`This is your account dashboard. Here you can update your account information and more. To manage all users, `}
-        <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+        <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
           login to the admin dashboard
         </Link>
         {'.'}

examples/auth/next-app/app/create-account/CreateAccountForm/index.tsx

@@ -38,7 +38,7 @@ export const CreateAccountForm: React.FC = () => {
 
   const onSubmit = useCallback(
     async (data: FormData) => {
-      const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users`, {
+      const response = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users`, {
         method: 'POST',
         body: JSON.stringify(data),
         headers: {
@@ -75,7 +75,7 @@ export const CreateAccountForm: React.FC = () => {
     <form onSubmit={handleSubmit(onSubmit)} className={classes.form}>
       <p>
         {`This is where new customers can signup and create a new account. To manage all users, `}
-        <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+        <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
           login to the admin dashboard
         </Link>
         {'.'}

examples/auth/next-app/app/login/LoginForm/index.tsx

@@ -57,7 +57,7 @@ export const LoginForm: React.FC = () => {
         {' with the password '}
         <b>demo</b>
         {'. To manage your users, '}
-        <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+        <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
           login to the admin dashboard
         </Link>
         .

examples/auth/next-app/app/page.tsx

@@ -35,7 +35,7 @@ export default function Home() {
         {' to start the authentication flow. Once logged in, you will be redirected to the '}
         <Link href="/account">account page</Link>
         {` which is restricted to users only. To manage all users, `}
-        <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+        <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
           login to the admin dashboard
         </Link>
         {'.'}

examples/auth/next-app/app/recover-password/RecoverPasswordForm/index.tsx

@@ -25,13 +25,16 @@ export const RecoverPasswordForm: React.FC = () => {
   } = useForm<FormData>()
 
   const onSubmit = useCallback(async (data: FormData) => {
-    const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/forgot-password`, {
-      method: 'POST',
-      body: JSON.stringify(data),
-      headers: {
-        'Content-Type': 'application/json',
+    const response = await fetch(
+      `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/forgot-password`,
+      {
+        method: 'POST',
+        body: JSON.stringify(data),
+        headers: {
+          'Content-Type': 'application/json',
+        },
       },
-    })
+    )
 
     if (response.ok) {
       setSuccess(true)
@@ -52,7 +55,7 @@ export const RecoverPasswordForm: React.FC = () => {
             <p>
               {`Please enter your email below. You will receive an email message with instructions on
               how to reset your password. To manage your all users, `}
-              <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+              <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
                 login to the admin dashboard
               </Link>
               {'.'}

examples/auth/next-app/app/reset-password/ResetPasswordForm/index.tsx

@@ -32,13 +32,16 @@ export const ResetPasswordForm: React.FC = () => {
 
   const onSubmit = useCallback(
     async (data: FormData) => {
-      const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/reset-password`, {
-        method: 'POST',
-        body: JSON.stringify(data),
-        headers: {
-          'Content-Type': 'application/json',
+      const response = await fetch(
+        `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/reset-password`,
+        {
+          method: 'POST',
+          body: JSON.stringify(data),
+          headers: {
+            'Content-Type': 'application/json',
+          },
         },
-      })
+      )
 
       if (response.ok) {
         const json = await response.json()

examples/auth/next-pages/.env.example

@@ -1 +1 @@
-NEXT_PUBLIC_CMS_URL=http://localhost:3000
+NEXT_PUBLIC_PAYLOAD_URL=http://localhost:3000

examples/auth/next-pages/src/pages/account/index.tsx

@@ -40,15 +40,18 @@ const Account: React.FC = () => {
   const onSubmit = useCallback(
     async (data: FormData) => {
       if (user) {
-        const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/${user.id}`, {
-          // Make sure to include cookies with fetch
-          credentials: 'include',
-          method: 'PATCH',
-          body: JSON.stringify(data),
-          headers: {
-            'Content-Type': 'application/json',
+        const response = await fetch(
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/${user.id}`,
+          {
+            // Make sure to include cookies with fetch
+            credentials: 'include',
+            method: 'PATCH',
+            body: JSON.stringify(data),
+            headers: {
+              'Content-Type': 'application/json',
+            },
           },
-        })
+        )
 
         if (response.ok) {
           const json = await response.json()
@@ -91,7 +94,7 @@ const Account: React.FC = () => {
       <h1>Account</h1>
       <p>
         {`This is your account dashboard. Here you can update your account information and more. To manage all users, `}
-        <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+        <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
           login to the admin dashboard
         </Link>
         {'.'}

examples/auth/next-pages/src/pages/create-account/index.tsx

@@ -38,7 +38,7 @@ const CreateAccount: React.FC = () => {
 
   const onSubmit = useCallback(
     async (data: FormData) => {
-      const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users`, {
+      const response = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users`, {
         method: 'POST',
         body: JSON.stringify(data),
         headers: {
@@ -78,7 +78,7 @@ const CreateAccount: React.FC = () => {
       <form onSubmit={handleSubmit(onSubmit)} className={classes.form}>
         <p>
           {`This is where new customers can signup and create a new account. To manage all users, `}
-          <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+          <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
             login to the admin dashboard
           </Link>
           {'.'}

examples/auth/next-pages/src/pages/index.tsx

@@ -35,7 +35,7 @@ export default function Home() {
         {' to start the authentication flow. Once logged in, you will be redirected to the '}
         <Link href="/account">account page</Link>
         {` which is restricted to users only. To manage all users, `}
-        <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+        <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
           login to the admin dashboard
         </Link>
         {'.'}

examples/auth/next-pages/src/pages/login/index.tsx

@@ -60,7 +60,7 @@ const Login: React.FC = () => {
           {' with the password '}
           <b>demo</b>
           {'. To manage your users, '}
-          <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+          <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
             login to the admin dashboard
           </Link>
           .

examples/auth/next-pages/src/pages/recover-password/index.tsx

@@ -24,13 +24,16 @@ const RecoverPassword: React.FC = () => {
   } = useForm<FormData>()
 
   const onSubmit = useCallback(async (data: FormData) => {
-    const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/forgot-password`, {
-      method: 'POST',
-      body: JSON.stringify(data),
-      headers: {
-        'Content-Type': 'application/json',
+    const response = await fetch(
+      `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/forgot-password`,
+      {
+        method: 'POST',
+        body: JSON.stringify(data),
+        headers: {
+          'Content-Type': 'application/json',
+        },
       },
-    })
+    )
 
     if (response.ok) {
       setSuccess(true)
@@ -51,7 +54,7 @@ const RecoverPassword: React.FC = () => {
             <p>
               {`Please enter your email below. You will receive an email message with instructions on
               how to reset your password. To manage your all users, `}
-              <Link href={`${process.env.NEXT_PUBLIC_CMS_URL}/admin/collections/users`}>
+              <Link href={`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/admin/collections/users`}>
                 login to the admin dashboard
               </Link>
               {'.'}

examples/auth/next-pages/src/pages/reset-password/index.tsx

@@ -31,13 +31,16 @@ const ResetPassword: React.FC = () => {
 
   const onSubmit = useCallback(
     async (data: FormData) => {
-      const response = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/reset-password`, {
-        method: 'POST',
-        body: JSON.stringify(data),
-        headers: {
-          'Content-Type': 'application/json',
+      const response = await fetch(
+        `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/reset-password`,
+        {
+          method: 'POST',
+          body: JSON.stringify(data),
+          headers: {
+            'Content-Type': 'application/json',
+          },
         },
-      })
+      )
 
       if (response.ok) {
         const json = await response.json()

examples/auth/next-pages/src/providers/Auth/gql.ts

@@ -8,7 +8,7 @@ export const USER = `
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const gql = async (query): Promise<any> => {
   try {
-    const res = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/graphql`, {
+    const res = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/graphql`, {
       method: 'POST',
       credentials: 'include',
       headers: {

examples/auth/next-pages/src/providers/Auth/index.tsx

@@ -16,7 +16,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
   const create = useCallback<Create>(
     async args => {
       if (api === 'rest') {
-        const user = await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users`, args)
+        const user = await rest(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users`, args)
         setUser(user)
         return user
       }
@@ -38,7 +38,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
   const login = useCallback<Login>(
     async args => {
       if (api === 'rest') {
-        const user = await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/login`, args)
+        const user = await rest(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/login`, args)
         setUser(user)
         return user
       }
@@ -62,7 +62,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
 
   const logout = useCallback<Logout>(async () => {
     if (api === 'rest') {
-      await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/logout`)
+      await rest(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/logout`)
       setUser(null)
       return
     }
@@ -81,7 +81,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
     const fetchMe = async () => {
       if (api === 'rest') {
         const user = await rest(
-          `${process.env.NEXT_PUBLIC_CMS_URL}/api/users/me`,
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/me`,
           {},
           {
             method: 'GET',
@@ -111,7 +111,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
     async args => {
       if (api === 'rest') {
         const user = await rest(
-          `${process.env.NEXT_PUBLIC_CMS_URL}/api/users/forgot-password`,
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/forgot-password`,
           args,
         )
         setUser(user)
@@ -132,7 +132,10 @@ export const AuthProvider: React.FC<{ children: React.ReactNode; api?: 'rest' |
   const resetPassword = useCallback<ResetPassword>(
     async args => {
       if (api === 'rest') {
-        const user = await rest(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/reset-password`, args)
+        const user = await rest(
+          `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/reset-password`,
+          args,
+        )
         setUser(user)
         return user
       }

examples/auth/payload/.env.example

@@ -1,6 +1,6 @@
 PAYLOAD_PUBLIC_SITE_URL=http://localhost:3001
 PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
-MONGODB_URI=mongodb://127.0.0.1/payload-example-auth
+DATABASE_URI=mongodb://127.0.0.1/payload-example-auth
 PAYLOAD_SECRET=PAYLOAD_AUTH_EXAMPLE_SECRET_KEY
 COOKIE_DOMAIN=localhost
 PAYLOAD_PUBLIC_SEED=true

examples/auth/payload/nodemon.json

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

examples/auth/payload/package.json

@@ -17,6 +17,9 @@
     "lint:fix": "eslint --fix --ext .ts,.tsx src"
   },
   "dependencies": {
+    "@payloadcms/bundler-webpack": "latest",
+    "@payloadcms/db-mongodb": "latest",
+    "@payloadcms/richtext-slate": "latest",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
     "payload": "latest"

examples/auth/payload/src/collections/hooks/protectRoles.ts

@@ -1,6 +1,7 @@
-import type { User } from 'payload/generated-types'
 import type { FieldHook } from 'payload/types'
 
+import type { User } from '../../payload-types'
+
 // ensure there is always a `user` role
 // do not let non-admins change roles
 export const protectRoles: FieldHook<User & { id: string }> = async ({ req, data }) => {

examples/auth/payload/src/payload-types.ts

@@ -8,23 +8,61 @@
 
 export interface Config {
   collections: {
-    users: User;
-  };
-  globals: {};
+    users: User
+    'payload-preferences': PayloadPreference
+    'payload-migrations': PayloadMigration
+  }
+  globals: {}
 }
 export interface User {
-  id: string;
-  firstName?: string;
-  lastName?: string;
-  roles?: ('admin' | 'user')[];
-  updatedAt: string;
-  createdAt: string;
-  email: string;
-  resetPasswordToken?: string;
-  resetPasswordExpiration?: string;
-  salt?: string;
-  hash?: string;
-  loginAttempts?: number;
-  lockUntil?: string;
-  password?: string;
+  id: string
+  firstName?: string
+  lastName?: string
+  roles?: ('admin' | 'user')[]
+  updatedAt: string
+  createdAt: string
+  email: string
+  resetPasswordToken?: string
+  resetPasswordExpiration?: string
+  salt?: string
+  hash?: string
+  loginAttempts?: number
+  lockUntil?: string
+  password?: string
+}
+export interface PayloadPreference {
+  id: string
+  user: {
+    relationTo: 'users'
+    value: string | User
+  }
+  key?: string
+  value?:
+    | {
+        [k: string]: unknown
+      }
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | null
+  updatedAt: string
+  createdAt: string
+}
+export interface PayloadMigration {
+  id: string
+  name?: string
+  batch?: number
+  updatedAt: string
+  createdAt: string
+}
+
+declare module 'payload' {
+  export interface GeneratedTypes {
+    collections: {
+      users: User
+      'payload-preferences': PayloadPreference
+      'payload-migrations': PayloadMigration
+    }
+  }
 }

examples/auth/payload/src/payload.config.ts

@@ -1,3 +1,6 @@
+import { webpackBundler } from '@payloadcms/bundler-webpack'
+import { mongooseAdapter } from '@payloadcms/db-mongodb'
+import { slateEditor } from '@payloadcms/richtext-slate'
 import path from 'path'
 import { buildConfig } from 'payload/config'
 
@@ -7,10 +10,15 @@ import BeforeLogin from './components/BeforeLogin'
 export default buildConfig({
   collections: [Users],
   admin: {
+    bundler: webpackBundler(),
     components: {
       beforeLogin: [BeforeLogin],
     },
   },
+  editor: slateEditor({}),
+  db: mongooseAdapter({
+    url: process.env.DATABASE_URI,
+  }),
   cors: [
     process.env.PAYLOAD_PUBLIC_SERVER_URL || '',
     process.env.PAYLOAD_PUBLIC_SITE_URL || '',

examples/auth/payload/src/server.ts

@@ -18,7 +18,6 @@ app.get('/', (_, res) => {
 const start = async (): Promise<void> => {
   await payload.init({
     secret: process.env.PAYLOAD_SECRET,
-    mongoURL: process.env.MONGODB_URI,
     express: app,
     onInit: () => {
       payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)

examples/auth/payload/tsconfig.json

@@ -17,9 +17,6 @@
     "moduleResolution": "node",
     "resolveJsonModule": true,
     "paths": {
-      "payload/generated-types": [
-        "./src/payload-types.ts"
-      ],
       "node_modules/*": [
         "./node_modules/*"
       ]
@@ -36,4 +33,4 @@
   "ts-node": {
     "transpileOnly": true
   }
-}
+}

examples/custom-server/.env.example

@@ -1,6 +1,6 @@
-MONGODB_URI=mongodb://127.0.0.1/payload-example-custom-server
+DATABASE_URI=mongodb://127.0.0.1/payload-example-custom-server
 PAYLOAD_SECRET=PAYLOAD_CUSTOM_SERVER_EXAMPLE_SECRET_KEY
 PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
-NEXT_PUBLIC_SERVER_URL=http://localhost:3000
+NEXT_PUBLIC_PAYLOAD_URL=http://localhost:3000
 PAYLOAD_PUBLIC_SEED=true
 PAYLOAD_DROP_DATABASE=true

examples/custom-server/next.config.js

@@ -4,6 +4,6 @@ module.exports = {
   reactStrictMode: true,
   swcMinify: true,
   images: {
-    domains: ['localhost', process.env.NEXT_PUBLIC_SERVER_URL],
+    domains: ['localhost', process.env.NEXT_PUBLIC_PAYLOAD_URL],
   },
 }

examples/custom-server/nodemon.json

@@ -1,5 +1,6 @@
 {
   "watch": ["server.ts"],
-  "exec": "ts-node --project tsconfig.server.json src/server.ts",
-  "ext": "js ts"
+  "exec": "ts-node --project tsconfig.server.json src/server.ts -- -I",
+  "ext": "js ts",
+  "stdin": false
 }

examples/custom-server/package.json

@@ -20,6 +20,9 @@
     "lint:fix": "eslint --fix --ext .ts,.tsx src"
   },
   "dependencies": {
+    "@payloadcms/bundler-webpack": "latest",
+    "@payloadcms/db-mongodb": "latest",
+    "@payloadcms/richtext-slate": "latest",
     "dotenv": "^8.2.0",
     "escape-html": "^1.0.3",
     "express": "^4.17.1",

examples/custom-server/src/dotenv.js

@@ -0,0 +1,3 @@
+module.exports = {
+  config: () => null,
+}

examples/custom-server/src/getPayload.ts

@@ -22,10 +22,6 @@ interface Args {
 }
 
 export const getPayloadClient = async ({ initOptions, seed }: Args = {}): Promise<Payload> => {
-  if (!process.env.MONGODB_URI) {
-    throw new Error('MONGODB_URI environment variable is missing')
-  }
-
   if (!process.env.PAYLOAD_SECRET) {
     throw new Error('PAYLOAD_SECRET environment variable is missing')
   }
@@ -36,7 +32,6 @@ export const getPayloadClient = async ({ initOptions, seed }: Args = {}): Promis
 
   if (!cached.promise) {
     cached.promise = payload.init({
-      mongoURL: process.env.MONGODB_URI,
       secret: process.env.PAYLOAD_SECRET,
       local: initOptions?.express ? false : true,
       ...(initOptions || {}),

examples/custom-server/src/payload-types.ts

@@ -8,31 +8,70 @@
 
 export interface Config {
   collections: {
-    pages: Page;
-    users: User;
-  };
-  globals: {};
+    pages: Page
+    users: User
+    'payload-preferences': PayloadPreference
+    'payload-migrations': PayloadMigration
+  }
+  globals: {}
 }
 export interface Page {
-  id: string;
-  title: string;
+  id: string
+  title: string
   richText?: {
-    [k: string]: unknown;
-  }[];
-  slug?: string;
-  updatedAt: string;
-  createdAt: string;
+    [k: string]: unknown
+  }[]
+  slug?: string
+  updatedAt: string
+  createdAt: string
 }
 export interface User {
-  id: string;
-  updatedAt: string;
-  createdAt: string;
-  email: string;
-  resetPasswordToken?: string;
-  resetPasswordExpiration?: string;
-  salt?: string;
-  hash?: string;
-  loginAttempts?: number;
-  lockUntil?: string;
-  password?: string;
+  id: string
+  updatedAt: string
+  createdAt: string
+  email: string
+  resetPasswordToken?: string
+  resetPasswordExpiration?: string
+  salt?: string
+  hash?: string
+  loginAttempts?: number
+  lockUntil?: string
+  password?: string
+}
+export interface PayloadPreference {
+  id: string
+  user: {
+    relationTo: 'users'
+    value: string | User
+  }
+  key?: string
+  value?:
+    | {
+        [k: string]: unknown
+      }
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | null
+  updatedAt: string
+  createdAt: string
+}
+export interface PayloadMigration {
+  id: string
+  name?: string
+  batch?: number
+  updatedAt: string
+  createdAt: string
+}
+
+declare module 'payload' {
+  export interface GeneratedTypes {
+    collections: {
+      pages: Page
+      users: User
+      'payload-preferences': PayloadPreference
+      'payload-migrations': PayloadMigration
+    }
+  }
 }

examples/custom-server/src/payload.config.ts

@@ -1,3 +1,6 @@
+import { webpackBundler } from '@payloadcms/bundler-webpack'
+import { mongooseAdapter } from '@payloadcms/db-mongodb'
+import { slateEditor } from '@payloadcms/richtext-slate'
 import dotenv from 'dotenv'
 import path from 'path'
 
@@ -14,10 +17,25 @@ export default buildConfig({
   serverURL: process.env.PAYLOAD_PUBLIC_SERVER_URL || '',
   collections: [Pages],
   admin: {
+    bundler: webpackBundler(),
     components: {
       beforeLogin: [BeforeLogin],
     },
+    webpack: config => ({
+      ...config,
+      resolve: {
+        ...config.resolve,
+        alias: {
+          ...config.resolve.alias,
+          dotenv: path.resolve(__dirname, './dotenv.js'),
+        },
+      },
+    }),
   },
+  editor: slateEditor({}),
+  db: mongooseAdapter({
+    url: process.env.DATABASE_URI,
+  }),
   typescript: {
     outputFile: path.resolve(__dirname, 'payload-types.ts'),
   },

examples/draft-preview/next-app/.env.example

@@ -1,3 +1,3 @@
-NEXT_PUBLIC_CMS_URL=http://localhost:3000
+NEXT_PUBLIC_PAYLOAD_URL=http://localhost:3000
 NEXT_PRIVATE_DRAFT_SECRET=EXAMPLE_DRAFT_SECRET
 NEXT_PRIVATE_REVALIDATION_KEY=EXAMPLE_REVALIDATION_KEY

examples/draft-preview/next-app/app/_api/fetchPage.ts

@@ -16,7 +16,7 @@ export const fetchPage = async (
   const pageRes: {
     docs: Page[]
   } = await fetch(
-    `${process.env.NEXT_PUBLIC_CMS_URL}/api/pages?where[slug][equals]=${slug}${
+    `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/pages?where[slug][equals]=${slug}${
       draft && payloadToken ? '&draft=true' : ''
     }`,
     {

examples/draft-preview/next-app/app/_api/fetchPages.ts

@@ -3,7 +3,7 @@ import type { Page } from '../../payload-types'
 export const fetchPages = async (): Promise<Page[]> => {
   const pageRes: {
     docs: Page[]
-  } = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/pages?depth=0&limit=100`).then(res =>
+  } = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/pages?depth=0&limit=100`).then(res =>
     res.json(),
   ) // eslint-disable-line function-paren-newline
 

examples/draft-preview/next-app/app/_components/AdminBar/index.client.tsx

@@ -18,7 +18,7 @@ export const AdminBarClient: React.FC<PayloadAdminBarProps> = props => {
         <PayloadAdminBar
           {...props}
           logo={<Title />}
-          cmsURL={process.env.NEXT_PUBLIC_CMS_URL}
+          cmsURL={process.env.NEXT_PUBLIC_PAYLOAD_URL}
           onPreviewExit={async () => {
             await fetch(`/api/exit-preview`)
             window.location.reload()

examples/draft-preview/next-app/app/_components/Header/index.tsx

@@ -10,7 +10,7 @@ import classes from './index.module.scss'
 
 export async function Header() {
   const mainMenu: MainMenu = await fetch(
-    `${process.env.NEXT_PUBLIC_CMS_URL}/api/globals/main-menu`,
+    `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/globals/main-menu`,
   ).then(res => res.json())
 
   const { navItems } = mainMenu

examples/draft-preview/next-app/app/api/preview/route.ts

@@ -24,7 +24,7 @@ export async function GET(
   }
 
   // validate the Payload token
-  const userReq = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/me`, {
+  const userReq = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/me`, {
     headers: {
       Authorization: `JWT ${payloadToken}`,
     },

examples/draft-preview/next-app/payload-types.ts

@@ -8,52 +8,94 @@
 
 export interface Config {
   collections: {
-    pages: Page;
-    users: User;
-  };
+    pages: Page
+    users: User
+    'payload-preferences': PayloadPreference
+    'payload-migrations': PayloadMigration
+  }
   globals: {
-    'main-menu': MainMenu;
-  };
+    'main-menu': MainMenu
+  }
 }
 export interface Page {
-  id: string;
-  title: string;
-  slug?: string;
+  id: string
+  title: string
+  slug?: string
   richText: {
-    [k: string]: unknown;
-  }[];
-  updatedAt: string;
-  createdAt: string;
-  _status?: 'draft' | 'published';
+    [k: string]: unknown
+  }[]
+  updatedAt: string
+  createdAt: string
+  _status?: 'draft' | 'published'
 }
 export interface User {
-  id: string;
-  updatedAt: string;
-  createdAt: string;
-  email: string;
-  resetPasswordToken?: string;
-  resetPasswordExpiration?: string;
-  salt?: string;
-  hash?: string;
-  loginAttempts?: number;
-  lockUntil?: string;
-  password?: string;
+  id: string
+  updatedAt: string
+  createdAt: string
+  email: string
+  resetPasswordToken?: string
+  resetPasswordExpiration?: string
+  salt?: string
+  hash?: string
+  loginAttempts?: number
+  lockUntil?: string
+  password?: string
+}
+export interface PayloadPreference {
+  id: string
+  user: {
+    relationTo: 'users'
+    value: string | User
+  }
+  key?: string
+  value?:
+    | {
+        [k: string]: unknown
+      }
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | null
+  updatedAt: string
+  createdAt: string
+}
+export interface PayloadMigration {
+  id: string
+  name?: string
+  batch?: number
+  updatedAt: string
+  createdAt: string
 }
 export interface MainMenu {
-  id: string;
+  id: string
   navItems?: {
     link: {
-      type?: 'reference' | 'custom';
-      newTab?: boolean;
+      type?: 'reference' | 'custom'
+      newTab?: boolean
       reference: {
-        value: string | Page;
-        relationTo: 'pages';
-      };
-      url: string;
-      label: string;
-    };
-    id?: string;
-  }[];
-  updatedAt?: string;
-  createdAt?: string;
+        relationTo: 'pages'
+        value: string | Page
+      }
+      url: string
+      label: string
+    }
+    id?: string
+  }[]
+  updatedAt?: string
+  createdAt?: string
+}
+
+declare module 'payload' {
+  export interface GeneratedTypes {
+    collections: {
+      pages: Page
+      users: User
+      'payload-preferences': PayloadPreference
+      'payload-migrations': PayloadMigration
+    }
+    globals: {
+      'main-menu': MainMenu
+    }
+  }
 }

examples/draft-preview/next-pages/.env.example

@@ -1,2 +1,2 @@
-NEXT_PUBLIC_CMS_URL=http://localhost:3000
+NEXT_PUBLIC_PAYLOAD_URL=http://localhost:3000
 NEXT_PRIVATE_REVALIDATION_KEY=EXAMPLE_REVALIDATION_KEY

examples/draft-preview/next-pages/src/components/AdminBar/index.tsx

@@ -20,7 +20,7 @@ export const AdminBar: React.FC<{
         <PayloadAdminBar
           {...adminBarProps}
           logo={<Title />}
-          cmsURL={process.env.NEXT_PUBLIC_CMS_URL}
+          cmsURL={process.env.NEXT_PUBLIC_PAYLOAD_URL}
           onAuthChange={setUser}
           className={classes.payloadAdminBar}
           classNames={{

examples/draft-preview/next-pages/src/pages/[slug].tsx

@@ -7,7 +7,7 @@ import { Gutter } from '../components/Gutter'
 import RichText from '../components/RichText'
 import type { MainMenu, Page as PageType } from '../payload-types'
 
-import classes from './[slug].module.scss';
+import classes from './[slug].module.scss'
 
 const Page: React.FC<
   PageType & {
@@ -67,7 +67,7 @@ export const getStaticProps: GetStaticProps = async (context: GetStaticPropsCont
   )
 
   // when previewing, send the payload token to bypass draft access control
-  const pageReq = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/pages${searchParams}`, {
+  const pageReq = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/pages${searchParams}`, {
     headers: {
       ...(preview
         ? {
@@ -110,7 +110,7 @@ export const getStaticPaths: GetStaticPaths = async () => {
   let paths: Paths = []
 
   const pagesReq = await fetch(
-    `${process.env.NEXT_PUBLIC_CMS_URL}/api/pages?where[_status][equals]=published&depth=0&limit=300`,
+    `${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/pages?where[_status][equals]=published&depth=0&limit=300`,
   )
 
   const pagesData = await pagesReq.json()

examples/draft-preview/next-pages/src/pages/_app.tsx

@@ -13,7 +13,7 @@ export interface IGlobals {
 }
 
 export const getAllGlobals = async (): Promise<IGlobals> => {
-  const res = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/globals/main-menu?depth=1`)
+  const res = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/globals/main-menu?depth=1`)
   const mainMenu = await res.json()
 
   return {

examples/draft-preview/next-pages/src/pages/api/preview.ts

@@ -20,7 +20,7 @@ const preview = async (req: NextApiRequest, res: NextApiResponse): Promise<void>
   }
 
   // validate the Payload token
-  const userReq = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/users/me`, {
+  const userReq = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/users/me`, {
     headers: {
       Authorization: `JWT ${payloadToken}`,
     },

examples/draft-preview/next-pages/src/payload-types.ts

@@ -8,52 +8,94 @@
 
 export interface Config {
   collections: {
-    pages: Page;
-    users: User;
-  };
+    pages: Page
+    users: User
+    'payload-preferences': PayloadPreference
+    'payload-migrations': PayloadMigration
+  }
   globals: {
-    'main-menu': MainMenu;
-  };
+    'main-menu': MainMenu
+  }
 }
 export interface Page {
-  id: string;
-  title: string;
-  slug?: string;
+  id: string
+  title: string
+  slug?: string
   richText: {
-    [k: string]: unknown;
-  }[];
-  updatedAt: string;
-  createdAt: string;
-  _status?: 'draft' | 'published';
+    [k: string]: unknown
+  }[]
+  updatedAt: string
+  createdAt: string
+  _status?: 'draft' | 'published'
 }
 export interface User {
-  id: string;
-  updatedAt: string;
-  createdAt: string;
-  email: string;
-  resetPasswordToken?: string;
-  resetPasswordExpiration?: string;
-  salt?: string;
-  hash?: string;
-  loginAttempts?: number;
-  lockUntil?: string;
-  password?: string;
+  id: string
+  updatedAt: string
+  createdAt: string
+  email: string
+  resetPasswordToken?: string
+  resetPasswordExpiration?: string
+  salt?: string
+  hash?: string
+  loginAttempts?: number
+  lockUntil?: string
+  password?: string
+}
+export interface PayloadPreference {
+  id: string
+  user: {
+    relationTo: 'users'
+    value: string | User
+  }
+  key?: string
+  value?:
+    | {
+        [k: string]: unknown
+      }
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | null
+  updatedAt: string
+  createdAt: string
+}
+export interface PayloadMigration {
+  id: string
+  name?: string
+  batch?: number
+  updatedAt: string
+  createdAt: string
 }
 export interface MainMenu {
-  id: string;
+  id: string
   navItems?: {
     link: {
-      type?: 'reference' | 'custom';
-      newTab?: boolean;
+      type?: 'reference' | 'custom'
+      newTab?: boolean
       reference: {
-        value: string | Page;
-        relationTo: 'pages';
-      };
-      url: string;
-      label: string;
-    };
-    id?: string;
-  }[];
-  updatedAt?: string;
-  createdAt?: string;
+        relationTo: 'pages'
+        value: string | Page
+      }
+      url: string
+      label: string
+    }
+    id?: string
+  }[]
+  updatedAt?: string
+  createdAt?: string
+}
+
+declare module 'payload' {
+  export interface GeneratedTypes {
+    collections: {
+      pages: Page
+      users: User
+      'payload-preferences': PayloadPreference
+      'payload-migrations': PayloadMigration
+    }
+    globals: {
+      'main-menu': MainMenu
+    }
+  }
 }

examples/draft-preview/payload/.env.example

@@ -1,4 +1,4 @@
-MONGODB_URI=mongodb://127.0.0.1/payload-example-draft-preview
+DATABASE_URI=mongodb://127.0.0.1/payload-example-draft-preview
 PAYLOAD_SECRET=ENTER-STRING-HERE
 PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
 PAYLOAD_PUBLIC_SITE_URL=http://localhost:3001

examples/draft-preview/payload/README.md

@@ -42,7 +42,7 @@ See the [Collections](https://payloadcms.com/docs/configuration/collections) doc
     const searchParams = `?where[slug][equals]=${pageSlug}&depth=1${preview ? `&draft=true` : ''}`
 
     // when previewing, send the payload token to bypass draft access control
-    const pageReq = await fetch(`${process.env.NEXT_PUBLIC_CMS_URL}/api/pages${searchParams}`, {
+    const pageReq = await fetch(`${process.env.NEXT_PUBLIC_PAYLOAD_URL}/api/pages${searchParams}`, {
       headers: {
         ...preview ? {
           Authorization: `JWT ${payloadToken}`,

examples/draft-preview/payload/nodemon.json

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

examples/draft-preview/payload/package.json

@@ -18,6 +18,9 @@
     "lint:fix": "eslint --fix --ext .ts,.tsx src"
   },
   "dependencies": {
+    "@payloadcms/bundler-webpack": "latest",
+    "@payloadcms/db-mongodb": "latest",
+    "@payloadcms/richtext-slate": "latest",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
     "payload": "latest"

examples/draft-preview/payload/src/fields/richText/elements.ts

@@ -1,5 +1,5 @@
-import type { RichTextElement } from 'payload/dist/fields/config/types'
+import type { RichTextElement } from '@payloadcms/richtext-slate'
 
-const elements: RichTextElement[] = ['blockquote', 'h2', 'h3', 'h4', 'h5', 'h6', 'link']
+const elements: RichTextElement[] = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'blockquote', 'link']
 
 export default elements

examples/draft-preview/payload/src/fields/richText/index.ts

@@ -1,4 +1,6 @@
-import type { RichTextElement, RichTextField, RichTextLeaf } from 'payload/dist/fields/config/types'
+import { slateEditor } from '@payloadcms/richtext-slate'
+import type { RichTextElement, RichTextLeaf } from '@payloadcms/richtext-slate/dist/types'
+import type { RichTextField } from 'payload/types'
 
 import deepMerge from '../../utilities/deepMerge'
 import link from '../link'
@@ -25,60 +27,64 @@ const richText: RichText = (
       name: 'richText',
       type: 'richText',
       required: true,
-      admin: {
-        upload: {
-          collections: {
-            media: {
-              fields: [
-                {
-                  type: 'richText',
-                  name: 'caption',
-                  label: 'Caption',
-                  admin: {
-                    elements: [...elements],
-                    leaves: [...leaves],
+      editor: slateEditor({
+        admin: {
+          upload: {
+            collections: {
+              media: {
+                fields: [
+                  {
+                    type: 'richText',
+                    name: 'caption',
+                    label: 'Caption',
+                    editor: slateEditor({
+                      admin: {
+                        elements: [...elements],
+                        leaves: [...leaves],
+                      },
+                    }),
                   },
-                },
-                {
-                  type: 'radio',
-                  name: 'alignment',
-                  label: 'Alignment',
-                  options: [
-                    {
-                      label: 'Left',
-                      value: 'left',
-                    },
-                    {
-                      label: 'Center',
-                      value: 'center',
-                    },
-                    {
-                      label: 'Right',
-                      value: 'right',
-                    },
-                  ],
-                },
-                {
-                  name: 'enableLink',
-                  type: 'checkbox',
-                  label: 'Enable Link',
-                },
-                link({
-                  appearances: false,
-                  disableLabel: true,
-                  overrides: {
-                    admin: {
-                      condition: (_, data) => Boolean(data?.enableLink),
-                    },
+                  {
+                    type: 'radio',
+                    name: 'alignment',
+                    label: 'Alignment',
+                    options: [
+                      {
+                        label: 'Left',
+                        value: 'left',
+                      },
+                      {
+                        label: 'Center',
+                        value: 'center',
+                      },
+                      {
+                        label: 'Right',
+                        value: 'right',
+                      },
+                    ],
                   },
-                }),
-              ],
+                  {
+                    name: 'enableLink',
+                    type: 'checkbox',
+                    label: 'Enable Link',
+                  },
+                  link({
+                    appearances: false,
+                    disableLabel: true,
+                    overrides: {
+                      admin: {
+                        condition: (_, data) => Boolean(data?.enableLink),
+                      },
+                    },
+                  }),
+                ],
+              },
             },
           },
+          elements: [...elements, ...(additions.elements || [])],
+          leaves: [...leaves, ...(additions.leaves || [])],
         },
-        elements: [...elements, ...(additions.elements || [])],
-        leaves: [...leaves, ...(additions.leaves || [])],
-      },
+      }),
     },
     overrides,
   )

examples/draft-preview/payload/src/fields/richText/leaves.ts

@@ -1,4 +1,4 @@
-import type { RichTextLeaf } from 'payload/dist/fields/config/types'
+import { RichTextLeaf } from '@payloadcms/richtext-slate'
 
 const defaultLeaves: RichTextLeaf[] = ['bold', 'italic', 'underline']
 

examples/draft-preview/payload/src/payload-types.ts

@@ -8,52 +8,94 @@
 
 export interface Config {
   collections: {
-    pages: Page;
-    users: User;
-  };
+    pages: Page
+    users: User
+    'payload-preferences': PayloadPreference
+    'payload-migrations': PayloadMigration
+  }
   globals: {
-    'main-menu': MainMenu;
-  };
+    'main-menu': MainMenu
+  }
 }
 export interface Page {
-  id: string;
-  title: string;
-  slug?: string;
+  id: string
+  title: string
+  slug?: string
   richText: {
-    [k: string]: unknown;
-  }[];
-  updatedAt: string;
-  createdAt: string;
-  _status?: 'draft' | 'published';
+    [k: string]: unknown
+  }[]
+  updatedAt: string
+  createdAt: string
+  _status?: 'draft' | 'published'
 }
 export interface User {
-  id: string;
-  updatedAt: string;
-  createdAt: string;
-  email: string;
-  resetPasswordToken?: string;
-  resetPasswordExpiration?: string;
-  salt?: string;
-  hash?: string;
-  loginAttempts?: number;
-  lockUntil?: string;
-  password?: string;
+  id: string
+  updatedAt: string
+  createdAt: string
+  email: string
+  resetPasswordToken?: string
+  resetPasswordExpiration?: string
+  salt?: string
+  hash?: string
+  loginAttempts?: number
+  lockUntil?: string
+  password?: string
+}
+export interface PayloadPreference {
+  id: string
+  user: {
+    relationTo: 'users'
+    value: string | User
+  }
+  key?: string
+  value?:
+    | {
+        [k: string]: unknown
+      }
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | null
+  updatedAt: string
+  createdAt: string
+}
+export interface PayloadMigration {
+  id: string
+  name?: string
+  batch?: number
+  updatedAt: string
+  createdAt: string
 }
 export interface MainMenu {
-  id: string;
+  id: string
   navItems?: {
     link: {
-      type?: 'reference' | 'custom';
-      newTab?: boolean;
+      type?: 'reference' | 'custom'
+      newTab?: boolean
       reference: {
-        value: string | Page;
-        relationTo: 'pages';
-      };
-      url: string;
-      label: string;
-    };
-    id?: string;
-  }[];
-  updatedAt?: string;
-  createdAt?: string;
+        relationTo: 'pages'
+        value: string | Page
+      }
+      url: string
+      label: string
+    }
+    id?: string
+  }[]
+  updatedAt?: string
+  createdAt?: string
+}
+
+declare module 'payload' {
+  export interface GeneratedTypes {
+    collections: {
+      pages: Page
+      users: User
+      'payload-preferences': PayloadPreference
+      'payload-migrations': PayloadMigration
+    }
+    globals: {
+      'main-menu': MainMenu
+    }
+  }
 }

examples/draft-preview/payload/src/payload.config.ts

@@ -1,3 +1,6 @@
+import { webpackBundler } from '@payloadcms/bundler-webpack'
+import { mongooseAdapter } from '@payloadcms/db-mongodb'
+import { slateEditor } from '@payloadcms/richtext-slate'
 import path from 'path'
 import { buildConfig } from 'payload/config'
 
@@ -9,10 +12,15 @@ import { MainMenu } from './globals/MainMenu'
 export default buildConfig({
   collections: [Pages, Users],
   admin: {
+    bundler: webpackBundler(),
     components: {
       beforeLogin: [BeforeLogin],
     },
   },
+  editor: slateEditor({}),
+  db: mongooseAdapter({
+    url: process.env.DATABASE_URI,
+  }),
   serverURL: process.env.PAYLOAD_PUBLIC_SERVER_URL,
   cors: [
     process.env.PAYLOAD_PUBLIC_SERVER_URL || '',

examples/draft-preview/payload/src/seed/page.ts

@@ -1,7 +1,7 @@
 import type { Page } from '../payload-types'
 
 export const examplePage: Partial<Page> = {
-  title: 'Example Page',
+  title: 'Example Page (Published)',
   slug: 'example-page',
   _status: 'published',
   richText: [

examples/draft-preview/payload/src/server.ts

@@ -19,7 +19,6 @@ app.get('/', (_, res) => {
 const start = async (): Promise<void> => {
   await payload.init({
     secret: process.env.PAYLOAD_SECRET,
-    mongoURL: process.env.MONGODB_URI,
     express: app,
     onInit: () => {
       payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)

examples/draft-preview/payload/tsconfig.json

@@ -16,7 +16,6 @@
     "sourceMap": true,
     "resolveJsonModule": true,
     "paths": {
-      "payload/generated-types": ["./src/payload-types.ts"],
       "node_modules/*": ["./node_modules/*"]
     },
   },

examples/email/nodemon.json

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

examples/form-builder/cms/.env.example

@@ -1,4 +0,0 @@
-MONGODB_URI=mongodb://127.0.0.1/payload-example-form-builder
-PAYLOAD_SECRET=ENTER-STRING-HERE
-PAYLOAD_PUBLIC_SITE_URL=http://localhost:3000
-PAYLOAD_PUBLIC_SERVER_URL=http://localhost:8000

examples/form-builder/cms/.prettierrc.js

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

examples/form-builder/cms/nodemon.json

@@ -1,4 +0,0 @@
-{
-  "ext": "ts",
-  "exec": "ts-node src/server.ts"
-}

examples/form-builder/cms/src/fields/richText/elements.ts

@@ -1,13 +0,0 @@
-import { RichTextElement } from 'payload/dist/fields/config/types';
-
-const elements: RichTextElement[] = [
-  'blockquote',
-  'h2',
-  'h3',
-  'h4',
-  'h5',
-  'h6',
-  'link',
-];
-
-export default elements;

examples/form-builder/cms/src/fields/richText/index.ts

@@ -1,94 +0,0 @@
-import { RichTextElement, RichTextField, RichTextLeaf } from 'payload/dist/fields/config/types';
-import deepMerge from '../../utilities/deepMerge';
-import elements from './elements';
-import leaves from './leaves';
-import link from '../link';
-
-type RichText = (
-  overrides?: Partial<RichTextField>,
-  additions?: {
-    elements?: RichTextElement[]
-    leaves?: RichTextLeaf[]
-  }
-) => RichTextField
-
-const richText: RichText = (
-  overrides,
-  additions = {
-    elements: [],
-    leaves: [],
-  },
-) => deepMerge<RichTextField, Partial<RichTextField>>(
-  {
-    name: 'richText',
-    type: 'richText',
-    required: true,
-    admin: {
-      upload: {
-        collections: {
-          media: {
-            fields: [
-              {
-                type: 'richText',
-                name: 'caption',
-                label: 'Caption',
-                admin: {
-                  elements: [
-                    ...elements,
-                  ],
-                  leaves: [
-                    ...leaves,
-                  ],
-                },
-              },
-              {
-                type: 'radio',
-                name: 'alignment',
-                label: 'Alignment',
-                options: [
-                  {
-                    label: 'Left',
-                    value: 'left',
-                  },
-                  {
-                    label: 'Center',
-                    value: 'center',
-                  },
-                  {
-                    label: 'Right',
-                    value: 'right',
-                  },
-                ],
-              },
-              {
-                name: 'enableLink',
-                type: 'checkbox',
-                label: 'Enable Link',
-              },
-              link({
-                appearances: false,
-                disableLabel: true,
-                overrides: {
-                  admin: {
-                    condition: (_, data) => Boolean(data?.enableLink),
-                  },
-                },
-              }),
-            ],
-          },
-        },
-      },
-      elements: [
-        ...elements,
-        ...additions.elements || [],
-      ],
-      leaves: [
-        ...leaves,
-        ...additions.leaves || [],
-      ],
-    },
-  },
-  overrides,
-);
-
-export default richText;

examples/form-builder/cms/src/fields/richText/leaves.ts

@@ -1,9 +0,0 @@
-import { RichTextLeaf } from 'payload/dist/fields/config/types';
-
-const defaultLeaves: RichTextLeaf[] = [
-  'bold',
-  'italic',
-  'underline',
-];
-
-export default defaultLeaves;

examples/form-builder/cms/src/fields/slug.ts

@@ -1,23 +0,0 @@
-import { Field } from 'payload/types';
-import formatSlug from '../utilities/formatSlug';
-import deepMerge from '../utilities/deepMerge';
-
-type Slug = (fieldToUse?: string, overrides?: Partial<Field>) => Field
-
-export const slugField: Slug = (fieldToUse = 'title', overrides) => deepMerge<Field, Partial<Field>>(
-  {
-    name: 'slug',
-    label: 'Slug',
-    type: 'text',
-    index: true,
-    admin: {
-      position: 'sidebar',
-    },
-    hooks: {
-      beforeValidate: [
-        formatSlug(fieldToUse),
-      ],
-    },
-  },
-  overrides,
-);