payload 1.0.26 → 1.0.29

package/docs/access-control/fields.mdx

@@ -17,8 +17,10 @@ Field Access Control is specified with functions inside a field's config. All fi
 | **[`update`](#update)**  | Allows or denies the ability to update a field's value |
 
 **Example Collection config:**
-```js
-export default {
+```ts
+import { CollectionConfig } from 'payload/types';
+
+const Posts: CollectionConfig = {
   slug: 'posts',
   fields: [
     {
@@ -33,7 +35,7 @@ export default {
       // highlight-end
     };
   ],
-}
+};
 ```
 
 ### Create

package/docs/access-control/globals.mdx

@@ -18,16 +18,20 @@ You can define Global-level Access Control within each Global's `access` propert
 | **[`update`](#update)**  | Used in the `update` Global operation |
 
 **Example Global config:**
-```js
-export default {
+```ts
+import { GlobalConfig } from 'payload/types';
+
+const Header: GlobalConfig = {
   slug: "header",
   // highlight-start
   access: {
-    read: ({ req: { user } }) => { ... },
-    update: ({ req: { user } }) => { ... },
+    read: ({ req: { user } }) => { /* */ },
+    update: ({ req: { user } }) => { /* */ },
   },
   // highlight-end
 };
+
+export default Header;
 ```
 
 ### Read

package/docs/access-control/overview.mdx

@@ -23,7 +23,7 @@ Access control within Payload is extremely powerful while remaining easy and int
 
 **Default Access function:**
 
-```js
+```ts
 const defaultPayloadAccess = ({ req: { user } }) => {
   // Return `true` if a user is found
   // and `false` if it is undefined or null

package/docs/admin/components.mdx

@@ -38,9 +38,16 @@ You can override a set of admin panel-wide components by providing a component t
 #### Full example:
 
 `payload.config.js`
-```js
-import { buildConfig } from 'payload/config';
-import { MyCustomNav, MyCustomLogo, MyCustomIcon, MyCustomAccount, MyCustomDashboard, MyProvider } from './customComponents.js';
+```ts
+import { buildConfig } from 'payload/config'
+import {
+  MyCustomNav,
+  MyCustomLogo,
+  MyCustomIcon,
+  MyCustomAccount,
+  MyCustomDashboard,
+  MyProvider,
+} from './customComponents';
 
 export default buildConfig({
   admin: {
@@ -55,9 +62,9 @@ export default buildConfig({
         Dashboard: MyCustomDashboard,
       },
       providers: [MyProvider],
-    }
-  }
-})
+    },
+  },
+});
 ```
 
 *For more examples regarding how to customize components, look at the following [examples](https://github.com/payloadcms/payload/tree/master/test/admin/components).*
@@ -100,20 +107,17 @@ All Payload fields support the ability to swap in your own React components. So,
 
 When swapping out the `Field` component, you'll be responsible for sending and receiving the field's `value` from the form itself. To do so, import the `useField` hook as follows:
 
-```js
-import { useField } from 'payload/components/forms';
+```tsx
+import { useField } from 'payload/components/forms'
+
+type Props = { path: string }
 
-const CustomTextField = ({ path }) => {
+const CustomTextField: React.FC<Props> = ({ path }) => {
   // highlight-start
-  const { value, setValue } = useField({ path });
+  const { value, setValue } = useField<Props>({ path })
   // highlight-end
 
-  return (
-    <input
-      onChange={(e) => setValue(e.target.value)}
-      value={value}
-    />
-  )
+  return <input onChange={e => setValue(e.target.value)} value={value.path} />
 }
 ```
 
@@ -121,10 +125,10 @@ const CustomTextField = ({ path }) => {
 
 There are times when a custom field component needs to have access to data from other fields. This can be done using `getDataByPath` from `useWatchForm` as follows:
 
-```js
+```tsx
 import { useWatchForm } from 'payload/components/forms';
 
-const DisplayFee = () => {
+const DisplayFee: React.FC = () => {
   const { getDataByPath } = useWatchForm();
 
   const amount = getDataByPath('amount');
@@ -132,7 +136,7 @@ const DisplayFee = () => {
 
   if (amount && feePercentage) {
     return (
-      <span>The fee is ${ amount * feePercentage / 100 }</span>
+      <span>The fee is ${(amount * feePercentage) / 100}</span>
     );
   }
 };
@@ -142,10 +146,10 @@ const DisplayFee = () => {
 
 The document ID can be very useful for certain custom components. You can get the `id` from the `useDocumentInfo` hook. Here is an example of a `UI` field using `id` to link to related collections:
 
-```js
+```tsx
 import { useDocumentInfo } from 'payload/components/utilities';
 
-const LinkFromCategoryToPosts = () => {
+const LinkFromCategoryToPosts: React.FC = () => {
   // highlight-start
   const { id } = useDocumentInfo();
   // highlight-end
@@ -222,10 +226,10 @@ To make use of Payload SCSS variables / mixins to use directly in your own compo
 
 In any custom component you can get the selected locale with the `useLocale` hook. Here is a simple example:
 
-```js
+```tsx
 import { useLocale } from 'payload/components/utilities';
 
-const Greeting = () => {
+const Greeting: React.FC = () => {
   // highlight-start
   const locale = useLocale();
   // highlight-end
@@ -237,6 +241,6 @@ const Greeting = () => {
 
   return (
     <span> { trans[locale] } </span>
-  )
-}
+  );
+};
 ```

package/docs/admin/customizing-css.mdx

@@ -13,7 +13,7 @@ You can add your own CSS by providing your base Payload config with a path to yo
 To do so, provide your base Payload config with a path to your own stylesheet. It can be either a CSS or SCSS file.
 
 **Example in payload.config.js:**
-```js
+```ts
 import { buildConfig } from 'payload/config';
 import path from 'path';
 
@@ -21,7 +21,7 @@ const config = buildConfig({
 	admin: {
 		css: path.resolve(__dirname, 'relative/path/to/stylesheet.scss'),
 	},
-})
+});
 ```
 
 ### Overriding built-in styles

package/docs/admin/overview.mdx

@@ -45,14 +45,14 @@ All options for the Admin panel are defined in your base Payload config file.
 To specify which Collection to use to log in to the Admin panel, pass the `admin` options a `user` key equal to the slug of the Collection that you'd like to use.
 
 `payload.config.js`:
-```js
+```ts
 import { buildConfig } from 'payload/config';
 
 const config = buildConfig({
   admin: {
     user: 'admins', // highlight-line
   },
-})
+});
 ```
 
 By default, if you have not specified a Collection, Payload will automatically provide you with a `User` Collection which will be used to access the Admin panel. You can customize or override the fields and settings of the default `User` Collection by passing your own collection using `users` as its `slug` to Payload. When this is done, Payload will use your provided `User` Collection instead of its default version.

package/docs/admin/webpack.mdx

@@ -10,8 +10,8 @@ Payload uses Webpack 5 to build the Admin panel. It comes with support for many
 
 To extend the Webpack config, add the `webpack` key to your base Payload config, and provide a function that accepts the default Webpack config as its only argument:
 
-`payload.config.js`
-```js
+`payload.config.ts`
+```ts
 import { buildConfig } from 'payload/config';
 
 export default buildConfig({
@@ -24,7 +24,7 @@ export default buildConfig({
 		}
 		// highlight-end
 	}
-})
+});
 ```
 
 ### Aliasing server-only modules
@@ -52,16 +52,17 @@ You may rely on server-only packages such as the above to perform logic in acces
 <br/><br/>
 
 `collections/Subscriptions/index.js`
-```js
+```ts
+import { CollectionConfig } from 'payload/types';
 import createStripeSubscription from './hooks/createStripeSubscription';
 
-const Subscription = {
+const Subscription: CollectionConfig = {
 	slug: 'subscriptions',
 	hooks: {
 		beforeChange: [
 			createStripeSubscription,
 		]
-	}
+	},
 	fields: [
 		{
 			name: 'stripeSubscriptionID',
@@ -69,7 +70,7 @@ const Subscription = {
 			required: true,
 		}
 	]
-}
+};
 
 export default Subscription;
 ```

package/docs/authentication/config.mdx

@@ -49,7 +49,7 @@ To utilize your API key while interacting with the REST or GraphQL API, add the
 
 **For example, using Fetch:**
 
-```js
+```ts
 const response = await fetch("http://localhost:3000/api/pages", {
   headers: {
     Authorization: `${collection.labels.singular} API-Key ${YOUR_API_KEY}`,
@@ -77,8 +77,10 @@ Function that accepts one argument, containing `{ req, token, user }`, that allo
 
 Example:
 
-```js
-{
+```ts
+import { CollectionConfig } from 'payload/types';
+
+const Customers: CollectionConfig = {
   slug: 'customers',
   auth: {
     forgotPassword: {
@@ -104,7 +106,7 @@ Example:
       // highlight-end
     }
   }
-}
+};
 ```
 
 <Banner type="warning">
@@ -123,7 +125,7 @@ Similarly to the above `generateEmailHTML`, you can also customize the subject o
 
 Example:
 
-```js
+```ts
 {
   slug: 'customers',
   auth: {
@@ -148,8 +150,11 @@ Function that accepts one argument, containing `{ req, token, user }`, that allo
 
 Example:
 
-```js
-{
+```ts
+import { CollectionConfig } from 'payload/types';
+
+
+const Customers: CollectionConfig = {
   slug: 'customers',
   auth: {
     verify: {
@@ -163,7 +168,7 @@ Example:
       // highlight-end
     }
   }
-}
+};
 ```
 
 <Banner type="warning">
@@ -182,7 +187,7 @@ Similarly to the above `generateEmailHTML`, you can also customize the subject o
 
 Example:
 
-```js
+```ts
 {
   slug: 'customers',
   auth: {

package/docs/authentication/operations.mdx

@@ -17,7 +17,7 @@ The Access operation returns what a logged in user can and can't do with the col
 `GET http://localhost:3000/api/access`
 
 Example response:
-```js
+```ts
 {
   canAccessAdmin: true,
   collections: {
@@ -54,7 +54,7 @@ Example response:
 
 **Example GraphQL Query**:
 
-```
+```graphql
 query {
   Access {
     pages {
@@ -75,7 +75,7 @@ Returns either a logged in user with token or null when there is no logged in us
 `GET http://localhost:3000/api/[collection-slug]/me`
 
 Example response:
-```js
+```ts
 {
   user: { // The JWT "payload" ;) from the logged in user
     email: 'dev@payloadcms.com',
@@ -90,7 +90,7 @@ Example response:
 
 **Example GraphQL Query**:
 
-```
+```graphql
 query {
   Me[collection-singular-label] {
     user {
@@ -106,7 +106,7 @@ query {
 Accepts an `email` and `password`. On success, it will return the logged in user as well as a token that can be used to authenticate. In the GraphQL and REST APIs, this operation also automatically sets an HTTP-only cookie including the user's token. If you pass an Express `res` to the Local API operation, Payload will set a cookie there as well.
 
 **Example REST API login**:
-```js
+```ts
 const res = await fetch('http://localhost:3000/api/[collection-slug]/login', {
   method: 'POST',
   headers: {
@@ -137,7 +137,7 @@ const json = await res.json();
 
 **Example GraphQL Mutation**:
 
-```
+```graphql
 mutation {
   login[collection-singular-label](email: "dev@payloadcms.com", password: "yikes") {
     user {
@@ -151,7 +151,7 @@ mutation {
 
 **Example Local API login**:
 
-```js
+```ts
 const result = await payload.login({
   collection: '[collection-slug]',
   data: {
@@ -166,7 +166,7 @@ const result = await payload.login({
 As Payload sets HTTP-only cookies, logging out cannot be done by just removing a cookie in JavaScript, as HTTP-only cookies are inaccessible by JS within the browser. So, Payload exposes a `logout` operation to delete the token in a safe way.
 
 **Example REST API logout**:
-```js
+```ts
 const res = await fetch('http://localhost:3000/api/[collection-slug]/logout', {
   method: 'POST',
   headers: {
@@ -192,7 +192,7 @@ This operation requires a non-expired token to send back a new one. If the user'
 If successful, this operation will automatically renew the user's HTTP-only cookie and will send back the updated token in JSON.
 
 **Example REST API token refresh**:
-```js
+```ts
 const res = await fetch('http://localhost:3000/api/[collection-slug]/refresh-token', {
   method: 'POST',
   headers: {
@@ -239,18 +239,18 @@ mutation {
 If your collection supports email verification, the Verify operation will be exposed which accepts a verification token and sets the user's `_verified` property to `true`, thereby allowing the user to authenticate with the Payload API.
 
 **Example REST API user verification**:
-```js
+```ts
 const res = await fetch(`http://localhost:3000/api/[collection-slug]/verify/${TOKEN_HERE}`, {
   method: 'POST',
   headers: {
     'Content-Type': 'application/json',
   },
-})
+});
 ```
 
 **Example GraphQL Mutation**:
 
-```
+```graphql
 mutation {
   verifyEmail[collection-singular-label](token: "TOKEN_HERE")
 }
@@ -258,7 +258,7 @@ mutation {
 
 **Example Local API verification**:
 
-```js
+```ts
 const result = await payload.verifyEmail({
   collection: '[collection-slug]',
   token: 'TOKEN_HERE',
@@ -272,7 +272,7 @@ If a user locks themselves out and you wish to deliberately unlock them, you can
 To restrict who is allowed to unlock users, you can utilize the [`unlock`](/docs/access-control/overview#unlock) access control function.
 
 **Example REST API unlock**:
-```js
+```ts
 const res = await fetch(`http://localhost:3000/api/[collection-slug]/unlock`, {
   method: 'POST',
   headers: {
@@ -291,7 +291,7 @@ mutation {
 
 **Example Local API unlock**:
 
-```js
+```ts
 const result = await payload.unlock({
   collection: '[collection-slug]',
 })
@@ -306,7 +306,7 @@ The link to reset the user's password contains a token which is what allows the
 By default, the Forgot Password operations send users to the Payload Admin panel to reset their password, but you can customize the generated email to send users to the frontend of your app instead by [overriding the email HTML](/docs/authentication/config#forgot-password).
 
 **Example REST API Forgot Password**:
-```js
+```ts
 const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-password`, {
   method: 'POST',
   headers: {
@@ -315,7 +315,7 @@ const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-pass
   body: JSON.stringify({
     email: 'dev@payloadcms.com',
   }),
-})
+});
 ```
 
 **Example GraphQL Mutation**:
@@ -328,14 +328,14 @@ mutation {
 
 **Example Local API forgot password**:
 
-```js
+```ts
 const token = await payload.forgotPassword({
   collection: '[collection-slug]',
   data: {
     email: 'dev@payloadcms.com',
   },
   disableEmail: false // you can disable the auto-generation of email via local API
-})
+});
 ```
 
 <Banner type="success">
@@ -348,7 +348,7 @@ const token = await payload.forgotPassword({
 After a user has "forgotten" their password and a token is generated, that token can be used to send to the reset password operation along with a new password which will allow the user to reset their password securely.
 
 **Example REST API Reset Password**:
-```js
+```ts
 const res = await fetch(`http://localhost:3000/api/[collection-slug]/reset-password`, {
   method: 'POST',
   headers: {
@@ -358,7 +358,7 @@ const res = await fetch(`http://localhost:3000/api/[collection-slug]/reset-passw
     token: 'TOKEN_GOES_HERE'
     password: 'not-today',
   }),
-})
+});
 
 const json = await res.json();
 
@@ -379,7 +379,7 @@ const json = await res.json();
 
 **Example GraphQL Mutation**:
 
-```
+```graphql
 mutation {
   resetPassword[collection-singular-label](token: "TOKEN_GOES_HERE", password: "not-today")
 }

package/docs/authentication/overview.mdx

@@ -32,8 +32,10 @@ Every Payload Collection can opt-in to supporting Authentication by specifying t
 
 Simple example collection:
 
-```js
-const Admins = {
+```ts
+import { CollectionConfig } from 'payload/types';
+
+const Admins: CollectionConfig = {
   slug:
   // highlight-start
   auth: {
@@ -95,7 +97,7 @@ However, if you use `fetch` or similar APIs to retrieve Payload resources from i
 
 Fetch example, including credentials:
 
-```js
+```ts
 const response = await fetch('http://localhost:3000/api/pages', {
   credentials: 'include',
 });
@@ -124,8 +126,8 @@ So, if a user of coolsite.com is logged in and just browsing around on the inter
 
 To define domains that should allow users to identify themselves via the Payload HTTP-only cookie, use the `csrf` option on the base Payload config to whitelist domains that you trust.
 
-`payload.config.js`:
-```js
+`payload.config.ts`:
+```ts
 import { buildConfig } from 'payload/config';
 
 const config = buildConfig({
@@ -148,7 +150,7 @@ export default config;
 In addition to authenticating via an HTTP-only cookie, you can also identify users via the `Authorization` header on an HTTP request.
 
 Example:
-```js
+```ts
 const request = await fetch('http://localhost:3000', {
   headers: {
     Authorization: `JWT ${token}`

package/docs/authentication/using-middleware.mdx

@@ -15,7 +15,7 @@ This approach has a ton of benefits - it's great for isolation of concerns and l
 </Banner>
 
 Example in `server.js`:
-```js
+```ts
 import express from 'express';
 import payload from 'payload';
 

package/docs/configuration/collections.mdx

@@ -31,8 +31,10 @@ It's often best practice to write your Collections in separate files and then im
 
 #### Simple collection example
 
-```js
-const Orders = {
+```ts
+import { CollectionConfig } from 'payload/types';
+
+const Orders: CollectionConfig = {
 	slug: 'orders',
 	fields: [
 		{
@@ -47,7 +49,7 @@ const Orders = {
 			required: true,
 		}
 	]
-}
+};
 ```
 
 #### More collection config examples
@@ -80,8 +82,10 @@ If the function is specified, a Preview button will automatically appear in the
 
 **Example collection with preview function:**
 
-```js
-const Posts = {
+```ts
+import { CollectionConfig } from 'payload/types';
+
+const Posts: CollectionConfig = {
 	slug: 'posts',
 	fields: [
 		{
@@ -118,14 +122,14 @@ Collections support all field types that Payload has to offer—including simple
 
 You can import collection types as follows:
 
-```js
+```ts
 import { CollectionConfig } from 'payload/types';
 
 // This is the type used for incoming collection configs.
 // Only the bare minimum properties are marked as required.
 ```
 
-```js
+```ts
 import { SanitizedCollectionConfig } from 'payload/types';
 
 // This is the type used after an incoming collection config is fully sanitized.

package/docs/configuration/globals.mdx

@@ -28,8 +28,10 @@ As with Collection configs, it's often best practice to write your Globals in se
 
 #### Simple Global example
 
-```js
-const Nav = {
+```ts
+import { GlobalConfig } from 'payload/types';
+
+const Nav: GlobalConfig = {
 	slug: 'nav',
 	fields: [
 		{
@@ -47,7 +49,9 @@ const Nav = {
 			]
 		},
 	]
-}
+};
+
+export default Nav;
 ```
 
 #### Global config example
@@ -78,14 +82,14 @@ Globals support all field types that Payload has to offer—including simple fie
 
 You can import global types as follows:
 
-```js
+```ts
 import { GlobalConfig } from 'payload/types';
 
 // This is the type used for incoming global configs.
 // Only the bare minimum properties are marked as required.
 ```
 
-```js
+```ts
 import { SanitizedGlobalConfig } from 'payload/types';
 
 // This is the type used after an incoming global config is fully sanitized.