feat: adds req to filterOptions args (#10204)

Adds `req` to `filterOptions` arguments.
payloadcms · Dec 27, 2024 · cf8c0ae · cf8c0ae
1 parent bb0c8a8
commit cf8c0ae
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 0 deletions.
diff --git a/docs/fields/relationship.mdx b/docs/fields/relationship.mdx
@@ -156,6 +156,7 @@ called with an argument object with the following properties:
 | `siblingData` | An object containing document data that is scoped to only fields within the same parent of this field |
 | `id`          | The `id` of the current document being edited. `id` is `undefined` during the `create` operation      |
 | `user`        | An object containing the currently authenticated user                                                 |
+| `req`         | The Payload Request, which contains references to `payload`, `user`, `locale`, and more.              |
 
 ## Example
 

diff --git a/docs/fields/upload.mdx b/docs/fields/upload.mdx
@@ -108,6 +108,7 @@ called with an argument object with the following properties:
 | `siblingData` | An object containing document data that is scoped to only fields within the same parent of this field |
 | `id`          | The `id` of the current document being edited. `id` is `undefined` during the `create` operation      |
 | `user`        | An object containing the currently authenticated user                                                 |
+| `req`         | The Payload Request, which contains references to `payload`, `user`, `locale`, and more.              |
 
 ### Example#filter-options-example
 

diff --git a/packages/payload/src/fields/config/types.ts b/packages/payload/src/fields/config/types.ts
@@ -243,6 +243,7 @@ export type FilterOptionsProps<TData = any> = {
    * The collection `slug` to filter against, limited to this field's `relationTo` property.
    */
   relationTo: CollectionSlug
+  req: PayloadRequest
   /**
    * An object containing document data that is scoped to only fields within the same parent of this field.
    */

diff --git a/packages/payload/src/fields/validations.ts b/packages/payload/src/fields/validations.ts
@@ -525,6 +525,7 @@ const validateFilterOptions: Validate<
                 id,
                 data,
                 relationTo: collection,
+                req,
                 siblingData,
                 user,
               })

diff --git a/packages/ui/src/forms/fieldSchemasToFormState/addFieldStatePromise.ts b/packages/ui/src/forms/fieldSchemasToFormState/addFieldStatePromise.ts
@@ -532,6 +532,7 @@ export const addFieldStatePromise = async (args: AddFieldStatePromiseArgs): Prom
               id,
               data: fullData,
               relationTo: field.relationTo,
+              req,
               siblingData: data,
               user: req.user,
             })
-Original file line number
+Diff line change
@@ Expand Up / @@ -525,6 +525,7 @@ const validateFilterOptions: Validate< @@
                     id,
                     data,
                     relationTo: collection,
+                    req,
                     siblingData,
                     user,
                   })
@@ Expand Down @@