Files
payloadcms/test/folders-browse-by-disabled/int.spec.ts
Jarrod Flesch 337f6188da feat: optionally exclude collection documents from appearing in browse-by-folder (#12654)
Adds configurations for browse-by-folder document results. This PR
**does NOT** allow for filtering out folders on a per collection basis.
That will be addressed in a future PR 👍

### Disable browse-by-folder all together
```ts
type RootFoldersConfiguration = {
  /**
   * If true, the browse by folder view will be enabled
   *
   * @default true
   */
  browseByFolder?: boolean
  // ...rest of type
}
```

### Remove document types from appearing in the browse by folder view
```ts
type CollectionFoldersConfiguration =
  | boolean
  | {
      /**
       * If true, the collection documents will be included in the browse by folder view
       *
       * @default true
       */
      browseByFolder?: boolean
    }
```

### Misc
Fixes https://github.com/payloadcms/payload/issues/12631 where adding
folders.collectionOverrides was being set on the client config - it
should be omitted.

Fixes an issue where `baseListFilters` were not being respected.
2025-06-04 13:22:26 -04:00

196 lines
4.9 KiB
TypeScript

import type { Payload } from 'payload'
import path from 'path'
import { fileURLToPath } from 'url'
import type { NextRESTClient } from '../helpers/NextRESTClient.js'
import { initPayloadInt } from '../helpers/initPayloadInt.js'
let payload: Payload
let restClient: NextRESTClient
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
describe('folders', () => {
beforeAll(async () => {
;({ payload, restClient } = await initPayloadInt(dirname))
})
afterAll(async () => {
if (typeof payload.db.destroy === 'function') {
await payload.db.destroy()
}
})
beforeEach(async () => {
await payload.delete({
collection: 'posts',
depth: 0,
where: {
id: {
exists: true,
},
},
})
await payload.delete({
collection: 'payload-folders',
depth: 0,
where: {
id: {
exists: true,
},
},
})
})
describe('folder > subfolder querying', () => {
it('should populate subfolders for folder by ID', async () => {
const parentFolder = await payload.create({
collection: 'payload-folders',
data: {
name: 'Parent Folder',
},
})
const folderIDFromParams = parentFolder.id
await payload.create({
collection: 'payload-folders',
data: {
name: 'Nested 1',
folder: folderIDFromParams,
},
})
await payload.create({
collection: 'payload-folders',
data: {
name: 'Nested 2',
folder: folderIDFromParams,
},
})
const parentFolderQuery = await payload.findByID({
collection: 'payload-folders',
id: folderIDFromParams,
})
expect(parentFolderQuery.documentsAndFolders.docs).toHaveLength(2)
})
})
describe('folder > file querying', () => {
it('should populate files for folder by ID', async () => {
const parentFolder = await payload.create({
collection: 'payload-folders',
data: {
name: 'Parent Folder',
},
})
const folderIDFromParams = parentFolder.id
await payload.create({
collection: 'posts',
data: {
title: 'Post 1',
folder: folderIDFromParams,
},
})
await payload.create({
collection: 'posts',
data: {
title: 'Post 2',
folder: folderIDFromParams,
},
})
const parentFolderQuery = await payload.findByID({
collection: 'payload-folders',
id: folderIDFromParams,
})
expect(parentFolderQuery.documentsAndFolders.docs).toHaveLength(2)
})
})
describe('hooks', () => {
it('reparentChildFolder should change the child after updating the parent', async () => {
const parentFolder = await payload.create({
collection: 'payload-folders',
data: {
name: 'Parent Folder',
},
})
const childFolder = await payload.create({
collection: 'payload-folders',
data: {
name: 'Child Folder',
folder: parentFolder,
},
})
await payload.update({
collection: 'payload-folders',
data: { folder: childFolder },
id: parentFolder.id,
})
const parentAfter = await payload.findByID({
collection: 'payload-folders',
id: parentFolder.id,
depth: 0,
})
const childAfter = await payload.findByID({
collection: 'payload-folders',
id: childFolder.id,
depth: 0,
})
expect(childAfter.folder).toBeFalsy()
expect(parentAfter.folder).toBe(childFolder.id)
})
it('dissasociateAfterDelete should delete _folder value in children after deleting the folder', async () => {
const parentFolder = await payload.create({
collection: 'payload-folders',
data: {
name: 'Parent Folder',
},
})
const post = await payload.create({ collection: 'posts', data: { folder: parentFolder } })
await payload.delete({ collection: 'payload-folders', id: parentFolder.id })
const postAfter = await payload.findByID({ collection: 'posts', id: post.id })
expect(postAfter.folder).toBeFalsy()
})
it('deleteSubfoldersBeforeDelete deletes subfolders after deleting the parent folder', async () => {
const parentFolder = await payload.create({
collection: 'payload-folders',
data: {
name: 'Parent Folder',
},
})
const childFolder = await payload.create({
collection: 'payload-folders',
data: {
name: 'Child Folder',
folder: parentFolder,
},
})
await payload.delete({ collection: 'payload-folders', id: parentFolder.id })
await expect(
payload.findByID({
collection: 'payload-folders',
id: childFolder.id,
disableErrors: true,
}),
).resolves.toBeNull()
})
})
})