Files

Paul cb6a73e1b4 feat(storage-*): include modified headers into the response headers of files when using adapters (#12096 )

This PR makes it so that `modifyResponseHeaders` is supported in our
adapters when set on the collection config. Previously it would be
ignored.

This means that users can now modify or append new headers to what's
returned by each service.

```ts
import type { CollectionConfig } from 'payload'

export const Media: CollectionConfig = {
  slug: 'media',
  upload: {
    modifyResponseHeaders: ({ headers }) => {
      const newHeaders = new Headers(headers) // Copy existing headers
      newHeaders.set('X-Frame-Options', 'DENY') // Set new header

      return newHeaders
    },
  },
}
```

Also adds support for `void` return on the `modifyResponseHeaders`
function in the case where the user just wants to use existing headers
and doesn't need more control.

eg:

```ts
import type { CollectionConfig } from 'payload'

export const Media: CollectionConfig = {
  slug: 'media',
  upload: {
    modifyResponseHeaders: ({ headers }) => {
      headers.set('X-Frame-Options', 'DENY') // You can directly set headers without returning
    },
  },
}
```

Manual testing checklist (no CI e2es setup for these envs yet):
- [x] GCS
- [x] S3
- [x] Azure
- [x] UploadThing
- [x] Vercel Blob

---------

Co-authored-by: James <james@trbl.design>

2025-07-10 08:00:26 -07:00

src

feat(storage-*): include modified headers into the response headers of files when using adapters (#12096 )

2025-07-10 08:00:26 -07:00

.prettierignore

feat(plugin-cloud-storage): implement storage packages (#5928 )

2024-04-22 14:31:20 -04:00

.swcrc

feat(plugin-cloud-storage): implement storage packages (#5928 )

2024-04-22 14:31:20 -04:00

LICENSE.md

chore: update year in licenses (#10463 )

2025-01-10 14:05:37 -05:00

package.json

chore(release): v3.46.0 [skip ci]

2025-07-07 16:10:10 -04:00

README.md

feat(storage-*): large file uploads on Vercel (#11382 )

2025-02-26 21:59:34 +02:00

tsconfig.json

fix: reduce global DOM/Node type conflicts in server-only packages (#12737 )

2025-06-11 20:59:19 +00:00

README.md

Vercel Blob Storage for Payload

This package provides a simple way to use Vercel Blob storage with Payload.

NOTE: This package removes the need to use @payloadcms/plugin-cloud-storage as was needed in Payload 2.x.

Installation

pnpm add @payloadcms/storage-vercel-blob

Usage

Configure the collections object to specify which collections should use the Vercel Blob adapter. The slug must match one of your existing collection slugs.
Ensure you have BLOB_READ_WRITE_TOKEN set in your Vercel environment variables. This is usually set by Vercel automatically after adding blob storage to your project.
When enabled, this package will automatically set disableLocalStorage to true for each collection.
When deploying to Vercel, server uploads are limited with 4.5MB. Set clientUploads to true to do uploads directly on the client.

import { vercelBlobStorage } from '@payloadcms/storage-vercel-blob'
import { Media } from './collections/Media'
import { MediaWithPrefix } from './collections/MediaWithPrefix'

export default buildConfig({
  collections: [Media, MediaWithPrefix],
  plugins: [
    vercelBlobStorage({
      enabled: true, // Optional, defaults to true
      // Specify which collections should use Vercel Blob
      collections: {
        media: true,
        'media-with-prefix': {
          prefix: 'my-prefix',
        },
      },
      // Token provided by Vercel once Blob storage is added to your Vercel project
      token: process.env.BLOB_READ_WRITE_TOKEN,
    }),
  ],
})

Option	Description	Default
`enabled`	Whether or not to enable the plugin	`true`
`collections`	Collections to apply the Vercel Blob adapter to
`addRandomSuffix`	Add a random suffix to the uploaded file name in Vercel Blob storage	`false`
`cacheControlMaxAge`	Cache-Control max-age in seconds	`365 * 24 * 60 * 60` (1 Year)
`token`	Vercel Blob storage read/write token	`''`
`clientUploads`	Do uploads directly on the client to bypass limits on Vercel