payload 1.4.0 → 1.4.2

package/docs/configuration/globals.mdx

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

package/docs/fields/array.mdx

@@ -23,7 +23,7 @@ keywords: array, fields, config, configuration, documentation, Content Managemen
 
 | Option           | Description                                                                                                                                                                                                                                                                       |
 | ---------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.                                                                                                                                                                                                      |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                            |
 | **`label`**          | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                    |
 | **`fields`** *       | Array of field types to correspond to each row of the Array.                                                                                                                                                                                                                      |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                      |
@@ -46,7 +46,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 | Option                 | Description                     |
 | ---------------------- | ------------------------------- |
 | **`initCollapsed`**    | Set the initial collapsed state |
-| **`components.RowLabel`**  | Function or React component to be rendered as the label on the array row. Recieves `({ data, index, path })` as args |
+| **`components.RowLabel`**  | Function or React component to be rendered as the label on the array row. Receives `({ data, index, path })` as args |
 
 
 ### Example

package/docs/fields/blocks.mdx

@@ -24,7 +24,7 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
 
 | Option                  | Description                                                                                                                                                                                                                                                                        |
 |-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** *            | To be used as the property name when stored and retrieved from the database.                                                                                                                                                                                                       |
+| **`name`** *            | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
 | **`label`**             | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                                                                                                              |
 | **`blocks`** *          | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field.                                                                                                                                                                                    |
 | **`validate`**          | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |

package/docs/fields/checkbox.mdx

@@ -14,7 +14,7 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database. |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |

package/docs/fields/code.mdx

@@ -17,7 +17,7 @@ This field uses `prismjs` for syntax highlighting and `react-simple-code-editor`
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |

package/docs/fields/date.mdx

@@ -17,7 +17,7 @@ This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepic
 
 | Option             | Description                                                                                                                                                                                         |
 | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database.                                                                                                                        |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
 | **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                                    |
 | **`index`**        | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
 | **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |

package/docs/fields/email.mdx

@@ -14,7 +14,7 @@ keywords: email, fields, config, configuration, documentation, Content Managemen
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |

package/docs/fields/group.mdx

@@ -14,7 +14,7 @@ keywords: group, fields, config, configuration, documentation, Content Managemen
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`fields`** *       | Array of field types to nest within this Group. |
 | **`label`**          | Used as a heading in the Admin panel and to name the generated GraphQL type. |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |

package/docs/fields/number.mdx

@@ -14,7 +14,7 @@ keywords: number, fields, config, configuration, documentation, Content Manageme
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`min`**            | Minimum value accepted. Used in the default `validation` function. |
 | **`max`**            | Maximum value accepted. Used in the default `validation` function. |

package/docs/fields/overview.mdx

@@ -64,6 +64,10 @@ One of the most powerful parts about Payload is its ability for you to define fi
 
 In addition to being able to define access control on a document-level, you can define extremely granular permissions on a field by field level. For more information about field-level access control, [click here](/docs/access-control/overview#fields).
 
+### Field names
+
+Some fields use their `name` property as a unique identifier to store and retrieve from the database. `__v`, `salt`, and `hash` are all reserved field names which are sanitized from Payload's config and cannot be used.
+
 ### Validation
 
 Field validation is enforced automatically based on the field type and other properties such as `required` or `min` and `max` value constraints on certain field types. This default behavior can be replaced by providing your own validate function for any field. It will be used on both the frontend and the backend, so it should not rely on any Node-specific packages. The validation function can be either synchronous or asynchronous and expects to return either `true` or a string error message to display in both API responses and within the Admin panel.

package/docs/fields/point.mdx

@@ -17,7 +17,7 @@ The data structure in the database matches the GeoJSON structure to represent po
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Used as a field label in the Admin panel and to name the generated GraphQL type. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`index`**          | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. To support location queries, point index defaults to `2dsphere`, to disable the index set to `false`. |

package/docs/fields/radio.mdx

@@ -14,7 +14,7 @@ keywords: radio, fields, config, configuration, documentation, Content Managemen
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`options`** *      | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing an `label` string and a `value` string. |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |

package/docs/fields/relationship.mdx

@@ -20,7 +20,7 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`relationTo`** *   | Provide one or many collection `slug`s to be able to assign relationships to. |
 | **`filterOptions`**  | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options). |
 | **`hasMany`**        | Boolean when, if set to `true`, allows this field to have many relations instead of only one. |

package/docs/fields/rich-text.mdx

@@ -20,7 +20,7 @@ The Admin component is built on the powerful [`slatejs`](https://docs.slatejs.or
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
 | **`saveToJWT`**      | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |

package/docs/fields/select.mdx

@@ -15,7 +15,7 @@ keywords: select, multi-select, fields, config, configuration, documentation, Co
 
 | Option             | Description                                                                                                                                                                                         |
 | ------------------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database.                                                                                                                        |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
 | **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string.                                           |
 | **`hasMany`**      | Boolean when, if set to `true`, allows this field to have many selections instead of only one.                                                                                                      |
 | **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |

package/docs/fields/tabs.mdx

@@ -26,7 +26,7 @@ Each tab has its own required `label` and `fields` array. You can also optionall
 
 | Option            | Description |
 | ----------------- | ----------- |
-| **`name`**        | An optional property name to be used when stored and retrieved from the database, similar to a [Group](/docs/fields/group). |
+| **`name`**        | An optional property name to be used when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`** *     | The label to render on the tab itself. |
 | **`fields`** *    | The fields to render within this tab. |
 | **`description`** | Optionally render a description within this tab to describe the contents of the tab itself. |

package/docs/fields/text.mdx

@@ -14,7 +14,7 @@ keywords: text, fields, config, configuration, documentation, Content Management
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database. |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`minLength`**      | Used by the default validation function to ensure values are of a minimum character length. |

package/docs/fields/textarea.mdx

@@ -14,7 +14,7 @@ keywords: textarea, fields, config, configuration, documentation, Content Manage
 
 | Option           | Description |
 | ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.  |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
 | **`label`**          | Text used as a field label in the Admin panel or an object with keys for each language. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`minLength`**      | Used by the default validation function to ensure values are of a minimum character length. |

package/docs/fields/upload.mdx

@@ -25,7 +25,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
 
 | Option           | Description                                                                                                                                                                                         |
 | ---------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** *         | To be used as the property name when stored and retrieved from the database.                                                                                                                        |
+| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
 | **`*relationTo`** *  | Provide a single collection `slug` to allow this field to accept a relation to. <strong>Note: the related collection must be configured to support Uploads.</strong>                                |
 | **`filterOptions`**  | A query to filter which options appear in the UI and validate against. [More](#filtering-upload-options).                                                                                           |
 | **`maxDepth`**       | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth)                                                                      |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payload",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Node, React and MongoDB Headless CMS and Application Framework",
   "license": "MIT",
   "engines": {

package/dist/admin/components/forms/field-types/getFieldPath.d.ts

@@ -1,2 +0,0 @@
-import { Field } from '../../../../fields/config/types';
-export declare const getFieldPath: (path: string, field: Field) => string;

package/dist/admin/components/forms/field-types/getFieldPath.js

@@ -1,6 +0,0 @@
-import { fieldAffectsData } from '../../../../fields/config/types';
-export const getFieldPath = (path, field) => {
-    // prevents duplicate . on nesting non-named fields
-    const dot = path && path.slice(-1) === '.' ? '' : '.';
-    return `${path ? `${path}${dot}` : ''}${fieldAffectsData(field) ? field.name : ''}`;
-};