fix: thread req into interal folder payload operations (#12523)

Author: JarrodMFlesch

packages/next/src/views/BrowseByFolder/buildView.tsx

@@ -76,9 +76,8 @@ export const buildBrowseByFolderView = async (
 
   const { breadcrumbs, documents, subfolders } = await getFolderData({
     folderID,
-    payload: initPageResult.req.payload,
+    req: initPageResult.req,
     search: query?.search as string,
-    user: initPageResult.req.user,
   })
 
   const resolvedFolderID = breadcrumbs[breadcrumbs.length - 1]?.id

packages/next/src/views/CollectionFolders/buildView.tsx

@@ -112,9 +112,8 @@ export const buildCollectionFolderView = async (
     const { breadcrumbs, documents, subfolders } = await getFolderData({
       collectionSlug,
       folderID,
-      payload: initPageResult.req.payload,
+      req: initPageResult.req,
       search: query?.search as string,
-      user: initPageResult.req.user,
     })
 
     const resolvedFolderID = breadcrumbs[breadcrumbs.length - 1]?.id

packages/payload/src/folders/endpoints/populateFolderData.ts

@@ -33,9 +33,8 @@ export const populateFolderDataEndpoint: Endpoint = {
     const data = await getFolderData({
       collectionSlug: req.searchParams?.get('collectionSlug') || undefined,
       folderID: req.searchParams?.get('folderID') || undefined,
-      payload: req.payload,
+      req,
       search: req.searchParams?.get('search') || undefined,
-      user: req.user,
     })
 
     return Response.json(data)

packages/payload/src/folders/utils/getFolderBreadcrumbs.ts

@@ -1,12 +1,10 @@
-import type { User } from '../../index.js'
-import type { Document, Payload } from '../../types/index.js'
+import type { Document, PayloadRequest } from '../../types/index.js'
 import type { FolderBreadcrumb } from '../types.js'
 
 type GetFolderBreadcrumbsArgs = {
   breadcrumbs?: FolderBreadcrumb[]
   folderID?: number | string
-  payload: Payload
-  user?: User
+  req: PayloadRequest
 }
 /**
  * Builds breadcrumbs up from child folder
@@ -15,16 +13,17 @@ type GetFolderBreadcrumbsArgs = {
 export const getFolderBreadcrumbs = async ({
   breadcrumbs = [],
   folderID,
-  payload,
-  user,
+  req,
 }: GetFolderBreadcrumbsArgs): Promise<FolderBreadcrumb[] | null> => {
+  const { payload, user } = req
   const folderFieldName: string = payload.config.folders.fieldName
   if (folderID) {
     const folderQuery = await payload.find({
       collection: payload.config.folders.slug,
       depth: 0,
       limit: 1,
       overrideAccess: false,
+      req,
       select: {
         name: true,
         [folderFieldName]: true,
@@ -52,8 +51,7 @@ export const getFolderBreadcrumbs = async ({
             typeof folder[folderFieldName] === 'string'
               ? folder[folderFieldName]
               : folder[folderFieldName].id,
-          payload,
-          user,
+          req,
         })
       }
     }

packages/payload/src/folders/utils/getFolderData.ts

@@ -1,5 +1,5 @@
-import type { CollectionSlug, User } from '../../index.js'
-import type { Payload } from '../../types/index.js'
+import type { CollectionSlug } from '../../index.js'
+import type { PayloadRequest } from '../../types/index.js'
 import type { GetFolderDataResult } from '../types.js'
 
 import { parseDocumentID } from '../../index.js'
@@ -19,31 +19,22 @@ type Args = {
    * @default undefined
    */
   folderID?: number | string
-  /**
-   * The locale to use for the document query
-   * @default undefined
-   */
-  payload: Payload
+  req: PayloadRequest
   /**
    * Search term to filter documents by - only applicable IF `collectionSlug` exists and NO `folderID` is provided
    */
   search?: string
-  /**
-   * The user making the request
-   * @default undefined
-   */
-  user?: User
 }
 /**
  * Query for documents, subfolders and breadcrumbs for a given folder
  */
 export const getFolderData = async ({
   collectionSlug,
   folderID: _folderID,
-  payload,
+  req,
   search,
-  user,
 }: Args): Promise<GetFolderDataResult> => {
+  const { payload, user } = req
   const parentFolderID = parseDocumentID({
     id: _folderID,
     collectionSlug: payload.config.folders.slug,
@@ -52,17 +43,15 @@ export const getFolderData = async ({
 
   const breadcrumbsPromise = getFolderBreadcrumbs({
     folderID: parentFolderID,
-    payload,
-    user,
+    req,
   })
 
   if (parentFolderID) {
     // subfolders and documents are queried together
     const documentAndSubfolderPromise = queryDocumentsAndFoldersFromJoin({
       collectionSlug,
       parentFolderID,
-      payload,
-      user,
+      req,
     })
     const [breadcrumbs, documentsAndSubfolders] = await Promise.all([
       breadcrumbsPromise,
@@ -78,16 +67,14 @@ export const getFolderData = async ({
     // subfolders and documents are queried separately
     const subfoldersPromise = getOrphanedDocs({
       collectionSlug: payload.config.folders.slug,
-      payload,
+      req,
       search,
-      user,
     })
     const documentsPromise = collectionSlug
       ? getOrphanedDocs({
           collectionSlug,
-          payload,
+          req,
           search,
-          user,
         })
       : Promise.resolve([])
     const [breadcrumbs, subfolders, documents] = await Promise.all([

packages/payload/src/folders/utils/getFoldersAndDocumentsFromJoin.ts

@@ -1,7 +1,6 @@
-import type { User } from '../../auth/types.js'
 import type { PaginatedDocs } from '../../database/types.js'
 import type { CollectionSlug } from '../../index.js'
-import type { Document, Payload } from '../../types/index.js'
+import type { Document, PayloadRequest } from '../../types/index.js'
 import type { FolderOrDocument } from '../types.js'
 
 import { formatFolderOrDocumentItem } from './formatFolderOrDocumentItem.js'
@@ -13,15 +12,14 @@ type QueryDocumentsAndFoldersResults = {
 type QueryDocumentsAndFoldersArgs = {
   collectionSlug?: CollectionSlug
   parentFolderID: number | string
-  payload: Payload
-  user?: User
+  req: PayloadRequest
 }
 export async function queryDocumentsAndFoldersFromJoin({
   collectionSlug,
   parentFolderID,
-  payload,
-  user,
+  req,
 }: QueryDocumentsAndFoldersArgs): Promise<QueryDocumentsAndFoldersResults> {
+  const { payload, user } = req
   const folderCollectionSlugs: string[] = payload.config.collections.reduce<string[]>(
     (acc, collection) => {
       if (collection?.folders) {
@@ -50,6 +48,7 @@ export async function queryDocumentsAndFoldersFromJoin({
     },
     limit: 1,
     overrideAccess: false,
+    req,
     user,
     where: {
       id: {

packages/payload/src/folders/utils/getOrphanedDocs.ts

@@ -1,20 +1,19 @@
-import type { CollectionSlug, Payload, User, Where } from '../../index.js'
+import type { CollectionSlug, PayloadRequest, Where } from '../../index.js'
 import type { FolderOrDocument } from '../types.js'
 
 import { formatFolderOrDocumentItem } from './formatFolderOrDocumentItem.js'
 
 type Args = {
   collectionSlug: CollectionSlug
-  payload: Payload
+  req: PayloadRequest
   search?: string
-  user?: User
 }
 export async function getOrphanedDocs({
   collectionSlug,
-  payload,
+  req,
   search,
-  user,
 }: Args): Promise<FolderOrDocument[]> {
+  const { payload, user } = req
   let whereConstraints: Where = {
     or: [
       {
@@ -42,6 +41,7 @@ export async function getOrphanedDocs({
     collection: collectionSlug,
     limit: 0,
     overrideAccess: false,
+    req,
     sort: payload.collections[collectionSlug].config.admin.useAsTitle,
     user,
     where: whereConstraints,