payload 1.7.1 → 1.7.3

package/dist/webpack/getProdConfig.d.ts

@@ -1,4 +1,4 @@
-import { Configuration } from 'webpack';
-import { SanitizedConfig } from '../config/types';
-declare const _default: (payloadConfig: SanitizedConfig) => Configuration;
-export default _default;
+import { Configuration } from 'webpack';
+import { SanitizedConfig } from '../config/types';
+declare const _default: (payloadConfig: SanitizedConfig) => Configuration;
+export default _default;

package/dist/webpack/getProdConfig.js

@@ -1,74 +1,74 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const mini_css_extract_plugin_1 = __importDefault(require("mini-css-extract-plugin"));
-const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
-const getBaseConfig_1 = __importDefault(require("./getBaseConfig"));
-// eslint-disable-next-line import/no-extraneous-dependencies, @typescript-eslint/no-var-requires
-const SwcMinifyWebpackPlugin = require('swc-minify-webpack-plugin');
-exports.default = (payloadConfig) => {
-    const baseConfig = (0, getBaseConfig_1.default)(payloadConfig);
-    let config = {
-        ...baseConfig,
-        output: {
-            publicPath: `${payloadConfig.routes.admin}/`,
-            path: payloadConfig.admin.buildPath,
-            filename: '[name].[chunkhash].js',
-            chunkFilename: '[name].[chunkhash].js',
-        },
-        mode: 'production',
-        stats: 'errors-only',
-        optimization: {
-            minimizer: [new SwcMinifyWebpackPlugin()],
-            splitChunks: {
-                cacheGroups: {
-                    styles: {
-                        name: 'styles',
-                        test: /\.(sa|sc|c)ss$/,
-                        chunks: 'all',
-                        enforce: true,
-                    },
-                },
-            },
-        },
-        plugins: [
-            ...baseConfig.plugins,
-            new mini_css_extract_plugin_1.default({
-                filename: '[name].css',
-                ignoreOrder: true,
-            }),
-        ],
-    };
-    config.module.rules.push({
-        test: /\.(scss|css)$/,
-        sideEffects: true,
-        use: [
-            mini_css_extract_plugin_1.default.loader,
-            {
-                loader: require.resolve('css-loader'),
-                options: {
-                    url: (url) => (!url.startsWith('/')),
-                },
-            },
-            {
-                loader: require.resolve('postcss-loader'),
-                options: {
-                    postcssOptions: {
-                        plugins: [require.resolve('postcss-preset-env')],
-                    },
-                },
-            },
-            require.resolve('sass-loader'),
-        ],
-    });
-    if (process.env.PAYLOAD_ANALYZE_BUNDLE) {
-        config.plugins.push(new webpack_bundle_analyzer_1.BundleAnalyzerPlugin());
-    }
-    if (payloadConfig.admin.webpack && typeof payloadConfig.admin.webpack === 'function') {
-        config = payloadConfig.admin.webpack(config);
-    }
-    return config;
-};
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mini_css_extract_plugin_1 = __importDefault(require("mini-css-extract-plugin"));
+const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
+const getBaseConfig_1 = __importDefault(require("./getBaseConfig"));
+// eslint-disable-next-line import/no-extraneous-dependencies, @typescript-eslint/no-var-requires
+const SwcMinifyWebpackPlugin = require('swc-minify-webpack-plugin');
+exports.default = (payloadConfig) => {
+    const baseConfig = (0, getBaseConfig_1.default)(payloadConfig);
+    let config = {
+        ...baseConfig,
+        output: {
+            publicPath: `${payloadConfig.routes.admin}/`,
+            path: payloadConfig.admin.buildPath,
+            filename: '[name].[chunkhash].js',
+            chunkFilename: '[name].[chunkhash].js',
+        },
+        mode: 'production',
+        stats: 'errors-only',
+        optimization: {
+            minimizer: [new SwcMinifyWebpackPlugin()],
+            splitChunks: {
+                cacheGroups: {
+                    styles: {
+                        name: 'styles',
+                        test: /\.(sa|sc|c)ss$/,
+                        chunks: 'all',
+                        enforce: true,
+                    },
+                },
+            },
+        },
+        plugins: [
+            ...baseConfig.plugins,
+            new mini_css_extract_plugin_1.default({
+                filename: '[name].css',
+                ignoreOrder: true,
+            }),
+        ],
+    };
+    config.module.rules.push({
+        test: /\.(scss|css)$/,
+        sideEffects: true,
+        use: [
+            mini_css_extract_plugin_1.default.loader,
+            {
+                loader: require.resolve('css-loader'),
+                options: {
+                    url: (url) => (!url.startsWith('/')),
+                },
+            },
+            {
+                loader: require.resolve('postcss-loader'),
+                options: {
+                    postcssOptions: {
+                        plugins: [require.resolve('postcss-preset-env')],
+                    },
+                },
+            },
+            require.resolve('sass-loader'),
+        ],
+    });
+    if (process.env.PAYLOAD_ANALYZE_BUNDLE) {
+        config.plugins.push(new webpack_bundle_analyzer_1.BundleAnalyzerPlugin());
+    }
+    if (payloadConfig.admin.webpack && typeof payloadConfig.admin.webpack === 'function') {
+        config = payloadConfig.admin.webpack(config);
+    }
+    return config;
+};
 //# sourceMappingURL=getProdConfig.js.map

package/dist/webpack/init.d.ts

@@ -1,4 +1,4 @@
-import { Router } from 'express';
-import { SanitizedConfig } from '../config/types';
-declare function initWebpack(config: SanitizedConfig): Router;
-export default initWebpack;
+import { Router } from 'express';
+import { SanitizedConfig } from '../config/types';
+declare function initWebpack(config: SanitizedConfig): Router;
+export default initWebpack;

package/dist/webpack/init.js

@@ -1,22 +1,22 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const webpack_1 = __importDefault(require("webpack"));
-const express_1 = __importDefault(require("express"));
-const webpack_dev_middleware_1 = __importDefault(require("webpack-dev-middleware"));
-const webpack_hot_middleware_1 = __importDefault(require("webpack-hot-middleware"));
-const getDevConfig_1 = __importDefault(require("./getDevConfig"));
-const router = express_1.default.Router();
-function initWebpack(config) {
-    const webpackDevConfig = (0, getDevConfig_1.default)(config);
-    const compiler = (0, webpack_1.default)(webpackDevConfig);
-    router.use((0, webpack_dev_middleware_1.default)(compiler, {
-        publicPath: webpackDevConfig.output.publicPath,
-    }));
-    router.use((0, webpack_hot_middleware_1.default)(compiler));
-    return router;
-}
-exports.default = initWebpack;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const webpack_1 = __importDefault(require("webpack"));
+const express_1 = __importDefault(require("express"));
+const webpack_dev_middleware_1 = __importDefault(require("webpack-dev-middleware"));
+const webpack_hot_middleware_1 = __importDefault(require("webpack-hot-middleware"));
+const getDevConfig_1 = __importDefault(require("./getDevConfig"));
+const router = express_1.default.Router();
+function initWebpack(config) {
+    const webpackDevConfig = (0, getDevConfig_1.default)(config);
+    const compiler = (0, webpack_1.default)(webpackDevConfig);
+    router.use((0, webpack_dev_middleware_1.default)(compiler, {
+        publicPath: webpackDevConfig.output.publicPath,
+    }));
+    router.use((0, webpack_hot_middleware_1.default)(compiler));
+    return router;
+}
+exports.default = initWebpack;
 //# sourceMappingURL=init.js.map

package/dist/webpack/mocks/dotENV.d.ts

@@ -1,4 +1,4 @@
-declare namespace _default {
-    function config(): any;
-}
-export default _default;
+declare namespace _default {
+    function config(): any;
+}
+export default _default;

package/dist/webpack/mocks/dotENV.js

@@ -1,6 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    config: () => null,
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    config: () => null,
+};
 //# sourceMappingURL=dotENV.js.map

package/dist/webpack/mocks/emptyModule.d.ts

@@ -1,2 +1,2 @@
-declare function _default(): void;
-export default _default;
+declare function _default(): void;
+export default _default;

package/dist/webpack/mocks/emptyModule.js

@@ -1,4 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = () => { };
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = () => { };
 //# sourceMappingURL=emptyModule.js.map

package/dist/webpack/mocks/fileMock.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "file-stub";
-export default _default;
+declare const _default: "file-stub";
+export default _default;

package/dist/webpack/mocks/fileMock.js

@@ -1,4 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 'file-stub';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = 'file-stub';
 //# sourceMappingURL=fileMock.js.map

package/docs/access-control/collections.mdx

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

package/docs/access-control/fields.mdx

@@ -20,7 +20,7 @@ Field Access Control is specified with functions inside a field's config. All fi
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Posts: CollectionConfig = {
+export const Posts: CollectionConfig = {
   slug: 'posts',
   fields: [
     {
@@ -67,6 +67,8 @@ Returns a boolean which allows or denies the ability to read a field's value. If
 
 Returns a boolean which allows or denies the ability to update a field's value. If `false` is returned, any passed values will be discarded.
 
+If `false` is returned and you attempt to update the field's value, the operation will **not** throw an error however the field will be omitted from the update operation and the value will remain unchanged.
+
 **Available argument properties:**
 
 | Option            | Description |

package/docs/admin/webpack.mdx

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

package/docs/authentication/config.mdx

@@ -82,7 +82,7 @@ Example:
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Customers: CollectionConfig = {
+export const Customers: CollectionConfig = {
   slug: 'customers',
   auth: {
     forgotPassword: {
@@ -156,7 +156,7 @@ Example:
 import { CollectionConfig } from 'payload/types';
 
 
-const Customers: CollectionConfig = {
+export const Customers: CollectionConfig = {
   slug: 'customers',
   auth: {
     verify: {

package/docs/authentication/overview.mdx

@@ -35,8 +35,8 @@ Simple example collection:
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Admins: CollectionConfig = {
-  slug:
+export const Admins: CollectionConfig = {
+  slug: 'admins',
   // highlight-start
   auth: {
     tokenExpiration: 7200, // How many seconds to keep the user logged in

package/docs/configuration/collections.mdx

@@ -16,6 +16,7 @@ It's often best practice to write your Collections in separate files and then im
 |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`slug`** *       | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                          |
 | **`fields`** *     | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
+| **`indexes`** *    | Array of database indexes to create, including compound indexes that have multiple fields.                                                                                                                               |
 | **`labels`**       | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                           |
 | **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-options).                                                                                                                                               |
 | **`hooks`**        | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/overview#collection-hooks)                                                                                                         |
@@ -38,7 +39,7 @@ It's often best practice to write your Collections in separate files and then im
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Orders: CollectionConfig = {
+export const Orders: CollectionConfig = {
 	slug: 'orders',
 	fields: [
 		{
@@ -52,7 +53,7 @@ const Orders: CollectionConfig = {
 			relationTo: 'customers',
 			required: true,
 		}
-	]
+	],
 };
 ```
 
@@ -94,7 +95,7 @@ If the function is specified, a Preview button will automatically appear in the
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Posts: CollectionConfig = {
+export const Posts: CollectionConfig = {
 	slug: 'posts',
 	fields: [
 		{

package/docs/configuration/globals.mdx

@@ -87,7 +87,7 @@ If the function is specified, a Preview button will automatically appear in the
 ```ts
 import { GlobalConfig } from "payload/types";
 
-const MyGlobal: GlobalConfig = {
+export const MyGlobal: GlobalConfig = {
   slug: "my-global",
   fields: [
     {

package/docs/configuration/i18n.mdx

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

package/docs/fields/array.mdx

@@ -56,7 +56,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/blocks.mdx

@@ -102,7 +102,7 @@ const QuoteBlock: Block = {
   ]
 };
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/checkbox.mdx

@@ -36,7 +36,7 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/code.mdx

@@ -51,7 +51,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/collapsible.mdx

@@ -35,7 +35,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/date.mdx

@@ -70,7 +70,7 @@ When only `pickerAppearance` is set, an equivalent format will be rendered in th
 ```ts
 import { CollectionConfig } from "payload/types";
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: "example-collection",
   fields: [
     {

package/docs/fields/email.mdx

@@ -49,7 +49,7 @@ Set this property to a string that will be used for browser autocomplete.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/group.mdx

@@ -43,7 +43,7 @@ Set this property to `true` to hide this field's gutter within the admin panel.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/json.mdx

@@ -48,7 +48,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/number.mdx

@@ -55,7 +55,7 @@ Set this property to a string that will be used for browser autocomplete.
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/overview.mdx

@@ -19,7 +19,7 @@ The required `type` property on a field determines what values it can accept, ho
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Page: CollectionConfig = {
+export const Page: CollectionConfig = {
 	slug: 'pages',
 	fields: [
 		{
@@ -90,7 +90,7 @@ Example:
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const Orders: CollectionConfig = {
+export const Orders: CollectionConfig = {
   slug: 'orders',
   fields: [
     {
@@ -175,10 +175,11 @@ All Payload fields support the ability to swap in your own React components with
 
 ### Conditional logic
 
-You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes two arguments:
+You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes three arguments:
 
 - `data` - the entire document's data that is currently being edited
 - `siblingData` - only the fields that are direct siblings to the field with the condition
+- `{ user }` - the final argument is an object containing the currently authenticated user
 
 The `condition` function should return a boolean that will control if the field should be displayed or not.
 
@@ -197,7 +198,7 @@ The `condition` function should return a boolean that will control if the field
       type: 'text',
       admin: {
         // highlight-start
-        condition: (data, siblingData) => {
+        condition: (data, siblingData, { user }) => {
           if (data.enableGreeting) {
             return true;
           } else {

package/docs/fields/point.mdx

@@ -40,7 +40,7 @@ The data structure in the database matches the GeoJSON structure to represent po
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {

package/docs/fields/radio.mdx

@@ -50,7 +50,7 @@ The `layout` property allows for the radio group to be styled as a horizonally o
 ```ts
 import { CollectionConfig } from 'payload/types';
 
-const ExampleCollection: CollectionConfig = {
+export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
   fields: [
     {
@@ -73,5 +73,4 @@ const ExampleCollection: CollectionConfig = {
     }
   ]
 }
-
 ```

package/docs/fields/relationship.mdx

@@ -20,7 +20,7 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma
 ### Config
 
 | Option              | Description                                                                                                                                                                                         |
-|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`name`** \*       | To be used as the property name when stored and retrieved from the database. [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).                                                                                     |
@@ -77,27 +77,34 @@ The `filterOptions` property can either be a `Where` query directly, or a functi
 | `id`          | The value of the collection `id`, will be `undefined` on create request              |
 | `user`        | The currently authenticated user object                                              |
 
-**Example:**
+### Example
 
 ```ts
-const relationshipField = {
-  name: "purchase",
-  type: "relationship",
-  relationTo: ["products", "services"],
-  filterOptions: ({ relationTo, siblingData }) => {
-    // returns a Where query dynamically by the type of relationship
-    if (relationTo === "products") {
-      return {
-        stock: { greater_than: siblingData.quantity },
-      };
-    }
+import { CollectionConfig } from "payload/types";
 
-    if (relationTo === "services") {
-      return {
-        isAvailable: { equals: true },
-      };
-    }
-  },
+export const ExampleCollection: CollectionConfig = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "purchase",
+      type: "relationship",
+      relationTo: ["products", "services"],
+      filterOptions: ({ relationTo, siblingData }) => {
+        // returns a Where query dynamically by the type of relationship
+        if (relationTo === "products") {
+          return {
+            stock: { greater_than: siblingData.quantity },
+          };
+        }
+
+        if (relationTo === "services") {
+          return {
+            isAvailable: { equals: true },
+          };
+        }
+      },
+    },
+  ],
 };
 ```