payload 1.0.34 → 1.1.0

package/docs/configuration/collections.mdx

@@ -61,6 +61,7 @@ You can customize the way that the Admin panel behaves on a collection-by-collec
 
 | Option                       | Description  |
 | ---------------------------- | -------------|
+| `group`                      | Text used as a label for grouping collection links together in the navigation. |
 | `useAsTitle`                 | Specify a top-level field to use for a document title throughout the Admin panel. If no field is defined, the ID of the document is used as the title. |
 | `description`                | Text or React component to display below the Collection label in the List view to give editors more information. |
 | `defaultColumns`             | Array of field names that correspond to which columns to show by default in this collection's List view. |
@@ -68,6 +69,7 @@ You can customize the way that the Admin panel behaves on a collection-by-collec
 | `enableRichTextRelationship` | The [Rich Text](/docs/fields/rich-text) field features a `Relationship` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
 | `preview`                    | Function to generate preview URLS within the Admin panel that can point to your app. [More](#preview). |
 | `components`                 | Swap in your own React components to be used within this collection. [More](/docs/admin/components#collections) |
+| `listSearchableFields `      | Specify which fields should be searched in the List search view. [More](/docs/configuration/collections#list-searchable-fields) |
 
 ### Preview
 
@@ -78,7 +80,7 @@ If the function is specified, a Preview button will automatically appear in the
 **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.
+1. An `options` object, containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT.
 
 **Example collection with preview function:**
 
@@ -118,6 +120,17 @@ Hooks are a powerful way to extend collection functionality and execute your own
 
 Collections support all field types that Payload has to offer—including simple fields like text and checkboxes all the way to more complicated layout-building field groups like Blocks. [Click here](/docs/fields/overview) to learn more about field types.
 
+#### List Searchable Fields
+
+In the List view, there is a "search" box that allows you to quickly find a document with a search. By default, it searches on the ID field. If you have `admin.useAsTitle` defined, the list search will use that field. However, you can define more than one field to search to make it easier on your admin editors to find the data they need.
+
+For example, let's say you have a Posts collection with `title`, `metaDescription`, and `tags` fields - and you want all three of those fields to be searchable in the List view. You can simply add `admin.listSearchableFields: ['title', 'metaDescription', 'tags']` - and the admin UI will automatically search on those three fields plus the ID field.
+
+<Banner type="warning">
+  <strong>Note:</strong><br/>
+  If you are adding <strong>listSearchableFields</strong>, make sure you index each of these fields so your admin queries can remain performant. 
+</Banner>
+
 ### TypeScript
 
 You can import collection types as follows:

package/docs/fields/array.mdx

@@ -35,10 +35,19 @@ keywords: array, fields, config, configuration, documentation, Content Managemen
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Array will be kept, so there is no need to specify each nested field as `localized`. |
 | **`required`**       | Require this field to have a value. |
 | **`labels`**         | Customize the row labels appearing in the Admin dashboard. |
-| **`admin`**          | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                  |
 
 *\* An asterisk denotes that a property is required.*
 
+### Admin Config
+
+In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
+
+| Option                 | Description                     |
+| ---------------------- | ------------------------------- |
+| **`initCollapsed`**    | Set the initial collapsed state |
+
+
 ### Example
 
 `collections/ExampleCollection.ts`

package/docs/fields/blocks.mdx

@@ -36,10 +36,18 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
 | **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. || **`required`**       | Require this field to have a value. |
 | **`unique`**         | Enforce that each entry in the Collection has a unique value for this field. |
 | **`labels`**         | Customize the block row labels appearing in the Admin dashboard. |
-| **`admin`**          | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                  |
 
 *\* An asterisk denotes that a property is required.*
 
+### Admin Config
+
+In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
+
+| Option                 | Description                     |
+| ---------------------- | ------------------------------- |
+| **`initCollapsed`**    | Set the initial collapsed state |
+
 ### Block configs
 
 Blocks are defined as separate configs of their own.

package/docs/fields/collapsible.mdx

@@ -12,14 +12,22 @@ keywords: row, fields, config, configuration, documentation, Content Management
 
 ### Config
 
-| Option           | Description |
-| ---------------- | ----------- |
-| **`label`** *        | A label to render within the header of the collapsible component. |
-| **`fields`** *       | Array of field types to nest within this Collapsible. |
-| **`admin`**          | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
+| Option         | Description                                                               |
+| -------------- | ------------------------------------------------------------------------- |
+| **`label`** *  | A label to render within the header of the collapsible component.         |
+| **`fields`** * | Array of field types to nest within this Collapsible.                     |
+| **`admin`**    | Admin-specific configuration. See below for [more detail](#admin-config). |
 
 *\* An asterisk denotes that a property is required.*
 
+### Admin Config
+
+In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
+
+| Option                 | Description                     |
+| ---------------------- | ------------------------------- |
+| **`initCollapsed`**    | Set the initial collapsed state |
+
 ### Example
 
 `collections/ExampleCollection.ts`

package/docs/fields/rich-text.mdx

@@ -77,6 +77,13 @@ The default `leaves` available in Payload are:
 
 Set this property to `true` to hide this field's gutter within the admin panel. The field gutter is rendered as a vertical line and padding, but often if this field is nested within a Group, Block, or Array, you may want to hide the gutter.
 
+**`link.fields`**
+
+This allows [fields](/docs/fields/overview) to be saved as extra fields on a link inside the Rich Text Editor. When this is present, the fields will render inside a modal that can be opened by clicking the "edit" button on the link element.
+
+![RichText link fields](https://payloadcms.com/images/fields/richText/rte-link-fields-modal.jpg)
+*RichText link with custom fields*
+
 **`upload.collections[collection-name].fields`**
 
 This allows [fields](/docs/fields/overview) to be saved as meta data on an upload field inside the Rich Text Editor. When this is present, the fields will render inside a modal that can be opened by clicking the "edit" button on the upload element.

package/docs/fields/tabs.mdx

@@ -7,7 +7,7 @@ keywords: tabs, fields, config, configuration, documentation, Content Management
 ---
 
 <Banner >
-  The Tabs field is presentational-only and only affects the Admin panel. By using it, you can place fields within a nice layout component that separates certain sub-fields by a tabbed interface.
+  The Tabs field is presentational-only and only affects the Admin panel (unless a tab is named). By using it, you can place fields within a nice layout component that separates certain sub-fields by a tabbed interface.
 </Banner>
 
 ![Tabs field type used to separate Hero fields from Page Layout](https://payloadcms.com/images/fields/tabs/tabs.jpg)
@@ -26,6 +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). |
 | **`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. |
@@ -56,10 +57,11 @@ const ExampleCollection: CollectionConfig = {
           ],
         },
         {
+          name: 'tabTwo',
           label: 'Tab Two Label', // required
           fields: [ // required
             {
-              name: 'numberField',
+              name: 'numberField', // accessible via tabTwo.numberField
               type: 'number',
               required: true,
             },

package/docs/hooks/collections.mdx

@@ -38,7 +38,7 @@ const ExampleHooks: CollectionConfig = {
   slug: 'example-hooks',
   fields: [
     { name: 'name', type: 'text'},
-  ]
+  ],
   hooks: {
     beforeOperation: [(args) => {...}],
     beforeValidate: [(args) => {...}],
@@ -56,7 +56,7 @@ const ExampleHooks: CollectionConfig = {
     afterRefresh: [(args) => {...}],
     afterMe: [(args) => {...}],
     afterForgotPassword: [(args) => {...}],
-  }
+  },
 }
 ```
 
@@ -121,6 +121,7 @@ import { CollectionAfterChangeHook } from 'payload/types';
 const afterChangeHook: CollectionAfterChangeHook = async ({
   doc, // full document data
   req, // full express request
+  previousDoc, // document data before updating the collection
   operation, // name of the operation ie. 'create', 'update'
 }) => {
   return doc;

package/docs/hooks/fields.mdx

@@ -56,15 +56,17 @@ All field-level hooks are formatted to accept the same arguments, although some
 
 Field Hooks receive one `args` argument that contains the following properties:
 
-| Option            | Description  |
-| ----------------- | -------------|
-| **`data`**        | The data passed to update the document within `create` and `update` operations, and the full document itself in the `afterRead` hook. |
-| **`findMany`**    | Boolean to denote if this hook is running against finding one, or finding many within the `afterRead` hook. |
-| **`operation`**   | A string relating to which operation the field type is currently executing within. Useful within `beforeValidate`, `beforeChange`, and `afterChange` hooks to differentiate between `create` and `update` operations. |
-| **`originalDoc`** | The full original document in `update` operations. |
-| **`req`**         | The Express `request` object. It is mocked for Local API operations. |
-| **`siblingData`** | The sibling data passed to a field that the hook is running against. |
-| **`value`**       | The value of the field. |
+| Option                   | Description                                                                                                                                                                                                           |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`data`**               | The data passed to update the document within `create` and `update` operations, and the full document itself in the `afterRead` hook.                                                                                 |
+| **`siblingData`**        | The sibling data passed to a field that the hook is running against.                                                                                                                                                  |
+| **`findMany`**           | Boolean to denote if this hook is running against finding one, or finding many within the `afterRead` hook.                                                                                                           |
+| **`operation`**          | A string relating to which operation the field type is currently executing within. Useful within `beforeValidate`, `beforeChange`, and `afterChange` hooks to differentiate between `create` and `update` operations. |
+| **`originalDoc`**        | The full original document in `update` operations. In the `afterChange` hook, this is the resulting document of the operation.                                                                                        |
+| **`previousDoc`**        | The document before changes were applied, only in `afterChange` hooks.                                                                                                                                                |
+| **`previousSiblingDoc`** | The sibling data from the previous document in `afterChange` hook.                                                                                                                                                    |
+| **`req`**                | The Express `request` object. It is mocked for Local API operations.                                                                                                                                                  |
+| **`value`**              | The value of the field.                                                                                                                                                                                               |
 
 #### Return value
 

package/docs/hooks/globals.mdx

@@ -78,6 +78,7 @@ import { GlobalAfterChangeHook } from 'payload/types'
 
 const afterChangeHook: GlobalAfterChangeHook = async ({
   doc, // full document data
+  previousDoc, // document data before updating the collection
   req, // full express request
 }) => {
   return data;

package/docs/upload/overview.mdx

@@ -45,6 +45,8 @@ Every Payload Collection can opt-in to supporting Uploads by specifying the `upl
 | **`staticURL`** \*        | The base URL path to use to access your uploads. Example: `/media`                                                                              |
 | **`staticDir`** \*        | The folder directory to use to store media in. Can be either an absolute path or relative to the directory that contains your config.           |
 | **`imageSizes`**          | If specified, image uploads will be automatically resized in accordance to these image sizes. [More](#image-sizes)                              |
+| **`formatOptions`**       | An object with `format` and `options` that are used with the Sharp image library to format the upload file. [More](https://sharp.pixelplumbing.com/api-output#toformat) |
+| **`resizeOptions`**       | An object passed to the the Sharp image library to resize the uploaded file. [More](https://sharp.pixelplumbing.com/api-resize)                              |
 | **`adminThumbnail`**      | Set the way that the Admin panel will display thumbnails for this Collection. [More](#admin-thumbnails)                                         |
 | **`mimeTypes`**           | Restrict mimeTypes in the file picker. Array of valid mimetypes or mimetype wildcards [More](#mimetypes)                                        |
 | **`disableLocalStorage`** | Completely disable uploading files to disk locally. [More](#disabling-local-upload-storage)                                                     |
@@ -68,13 +70,13 @@ const Media: CollectionConfig = {
         name: 'thumbnail',
         width: 400,
         height: 300,
-        crop: 'centre',
+        position: 'centre',
       },
       {
         name: 'card',
         width: 768,
         height: 1024,
-        crop: 'centre',
+        position: 'centre',
       },
       {
         name: 'tablet',
@@ -84,7 +86,7 @@ const Media: CollectionConfig = {
         // but it will retain its original aspect ratio
         // and calculate a height automatically.
         height: null,
-        crop: 'centre',
+        position: 'centre',
       },
     ],
     adminThumbnail: 'thumbnail',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payload",
-  "version": "1.0.34",
+  "version": "1.1.0",
   "description": "Node, React and MongoDB Headless CMS and Application Framework",
   "license": "MIT",
   "author": {
@@ -85,7 +85,7 @@
     "@babel/preset-typescript": "^7.12.1",
     "@babel/register": "^7.11.5",
     "@date-io/date-fns": "^2.10.6",
-    "@faceless-ui/modal": "1.2.0",
+    "@faceless-ui/modal": "^2.0.0-alpha.4",
     "@faceless-ui/scroll-info": "^1.2.3",
     "@faceless-ui/window-info": "^2.0.2",
     "@types/is-plain-object": "^2.0.4",
@@ -107,8 +107,8 @@
     "express-fileupload": "1.4.0",
     "express-graphql": "0.12.0",
     "express-rate-limit": "^5.1.3",
-    "falsey": "^1.0.0",
     "file-loader": "^6.2.0",
+    "file-type": "16.5.4",
     "find-up": "4.1.0",
     "flatley": "^5.2.0",
     "fs-extra": "^10.0.0",
@@ -127,9 +127,9 @@
     "json-schema-to-typescript": "^11.0.2",
     "jsonwebtoken": "^8.5.1",
     "jwt-decode": "^3.1.2",
+    "md5": "^2.3.0",
     "method-override": "^3.0.0",
     "micro-memoize": "^4.0.9",
-    "mime": "^2.5.0",
     "mini-css-extract-plugin": "1.3.3",
     "minimist": "^1.2.0",
     "mkdirp": "^1.0.4",